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

Contents

Description

 
Synopsis

Operations

DescribeRdsDbInstances

describeRdsDbInstances_rdsDbInstanceArns :: Lens' DescribeRdsDbInstances (Maybe [Text]) Source #

An array containing the ARNs of the instances to be described.

describeRdsDbInstances_stackId :: Lens' DescribeRdsDbInstances Text Source #

The ID of the stack with which the instances are registered. The operation returns descriptions of all registered Amazon RDS instances.

describeRdsDbInstancesResponse_rdsDbInstances :: Lens' DescribeRdsDbInstancesResponse (Maybe [RdsDbInstance]) Source #

An a array of RdsDbInstance objects that describe the instances.

DeleteStack

UpdateStack

updateStack_defaultInstanceProfileArn :: Lens' UpdateStack (Maybe Text) Source #

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

updateStack_serviceRoleArn :: Lens' UpdateStack (Maybe Text) Source #

Do not use this parameter. You cannot update a stack's service role.

updateStack_defaultRootDeviceType :: Lens' UpdateStack (Maybe RootDeviceType) Source #

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

updateStack_chefConfiguration :: Lens' UpdateStack (Maybe ChefConfiguration) Source #

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

updateStack_agentVersion :: Lens' UpdateStack (Maybe Text) Source #

The default AWS OpsWorks Stacks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

updateStack_defaultSshKeyName :: Lens' UpdateStack (Maybe Text) Source #

A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS OpsWorks Stacks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

updateStack_customJson :: Lens' UpdateStack (Maybe Text) Source #

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

updateStack_customCookbooksSource :: Lens' UpdateStack (Maybe Source) Source #

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

updateStack_defaultAvailabilityZone :: Lens' UpdateStack (Maybe Text) Source #

The stack's default Availability Zone, which must be in the stack's region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see CreateStack.

updateStack_attributes :: Lens' UpdateStack (Maybe (HashMap StackAttributesKeys (Maybe Text))) Source #

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

updateStack_name :: Lens' UpdateStack (Maybe Text) Source #

The stack's new name.

updateStack_defaultOs :: Lens' UpdateStack (Maybe Text) Source #

The stack's operating system, which must be set to one of the following:

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
  • CentOS Linux 7
  • Red Hat Enterprise Linux 7
  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the stack's current operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

updateStack_useOpsworksSecurityGroups :: Lens' UpdateStack (Maybe Bool) Source #

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. UseOpsworksSecurityGroups allows you to provide your own custom security groups instead of using the built-in groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
  • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

updateStack_useCustomCookbooks :: Lens' UpdateStack (Maybe Bool) Source #

Whether the stack uses custom cookbooks.

updateStack_defaultSubnetId :: Lens' UpdateStack (Maybe Text) Source #

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

updateStack_configurationManager :: Lens' UpdateStack (Maybe StackConfigurationManager) Source #

The configuration manager. When you update a stack, we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

updateStack_hostnameTheme :: Lens' UpdateStack (Maybe Text) Source #

The stack's new host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods
  • Clouds
  • Europe_Cities
  • Fruits
  • Greek_Deities_and_Titans
  • Legendary_creatures_from_Japan
  • Planets_and_Moons
  • Roman_Deities
  • Scottish_Islands
  • US_Cities
  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

CreateLayer

createLayer_customInstanceProfileArn :: Lens' CreateLayer (Maybe Text) Source #

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

createLayer_customSecurityGroupIds :: Lens' CreateLayer (Maybe [Text]) Source #

An array containing the layer custom security group IDs.

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

createLayer_cloudWatchLogsConfiguration :: Lens' CreateLayer (Maybe CloudWatchLogsConfiguration) Source #

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

createLayer_lifecycleEventConfiguration :: Lens' CreateLayer (Maybe LifecycleEventConfiguration) Source #

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.

createLayer_customRecipes :: Lens' CreateLayer (Maybe Recipes) Source #

A LayerCustomRecipes object that specifies the layer custom recipes.

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

createLayer_volumeConfigurations :: Lens' CreateLayer (Maybe [VolumeConfiguration]) Source #

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

createLayer_enableAutoHealing :: Lens' CreateLayer (Maybe Bool) Source #

Whether to disable auto healing for the layer.

createLayer_packages :: Lens' CreateLayer (Maybe [Text]) Source #

An array of Package objects that describes the layer packages.

createLayer_attributes :: Lens' CreateLayer (Maybe (HashMap LayerAttributesKeys (Maybe Text))) Source #

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.

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

createLayer_useEbsOptimizedInstances :: Lens' CreateLayer (Maybe Bool) Source #

Whether to use Amazon EBS-optimized instances.

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

createLayer_type :: Lens' CreateLayer LayerType Source #

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.

createLayer_name :: Lens' CreateLayer Text Source #

The layer name, which is used by the console.

createLayer_shortname :: Lens' CreateLayer 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 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 Stacks. For more information, see the Layer Reference.

SetLoadBasedAutoScaling

setLoadBasedAutoScaling_upScaling :: Lens' SetLoadBasedAutoScaling (Maybe AutoScalingThresholds) Source #

An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks Stacks starts a specified number of instances.

setLoadBasedAutoScaling_enable :: Lens' SetLoadBasedAutoScaling (Maybe Bool) Source #

Enables load-based auto scaling for the layer.

setLoadBasedAutoScaling_downScaling :: Lens' SetLoadBasedAutoScaling (Maybe AutoScalingThresholds) Source #

An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks Stacks stops a specified number of instances.

DeregisterRdsDbInstance

UnassignVolume

CreateInstance

createInstance_installUpdatesOnBoot :: Lens' CreateInstance (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 by 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.

createInstance_virtualizationType :: Lens' CreateInstance (Maybe Text) Source #

The instance's virtualization type, paravirtual or hvm.

createInstance_sshKeyName :: Lens' CreateInstance (Maybe Text) Source #

The instance's Amazon EC2 key-pair name.

createInstance_agentVersion :: Lens' CreateInstance (Maybe Text) Source #

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.
  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

createInstance_subnetId :: Lens' CreateInstance (Maybe Text) Source #

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

createInstance_ebsOptimized :: Lens' CreateInstance (Maybe Bool) Source #

Whether to create an Amazon EBS-optimized instance.

createInstance_os :: Lens' CreateInstance (Maybe Text) Source #

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
  • CentOS Linux 7
  • Red Hat Enterprise Linux 7
  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

createInstance_availabilityZone :: Lens' CreateInstance (Maybe Text) Source #

The instance Availability Zone. For more information, see Regions and Endpoints.

createInstance_tenancy :: Lens' CreateInstance (Maybe Text) Source #

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

createInstance_autoScalingType :: Lens' CreateInstance (Maybe AutoScalingType) Source #

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

createInstance_architecture :: Lens' CreateInstance (Maybe Architecture) Source #

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

createInstance_amiId :: Lens' CreateInstance (Maybe Text) Source #

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

If you specify a custom AMI, you must set Os to Custom.

createInstance_rootDeviceType :: Lens' CreateInstance (Maybe RootDeviceType) Source #

The instance root device type. For more information, see Storage for the Root Device.

createInstance_blockDeviceMappings :: Lens' CreateInstance (Maybe [BlockDeviceMapping]) Source #

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

createInstance_layerIds :: Lens' CreateInstance [Text] Source #

An array that contains the instance's layer IDs.

createInstance_instanceType :: Lens' CreateInstance Text Source #

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

DescribeLayers

describeLayers_layerIds :: Lens' DescribeLayers (Maybe [Text]) Source #

An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.

describeLayersResponse_layers :: Lens' DescribeLayersResponse (Maybe [Layer]) Source #

An array of Layer objects that describe the layers.

RegisterElasticIp

DescribeAgentVersions

describeAgentVersionsResponse_agentVersions :: Lens' DescribeAgentVersionsResponse (Maybe [AgentVersion]) Source #

The agent versions for the specified stack or configuration manager. Note that this value is the complete version number, not the abbreviated number used by the console.

CreateDeployment

createDeployment_customJson :: Lens' CreateDeployment (Maybe Text) Source #

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

createDeployment_appId :: Lens' CreateDeployment (Maybe Text) Source #

The app ID. This parameter is required for app deployments, but not for other deployment commands.

createDeployment_instanceIds :: Lens' CreateDeployment (Maybe [Text]) Source #

The instance IDs for the deployment targets.

createDeployment_layerIds :: Lens' CreateDeployment (Maybe [Text]) Source #

The layer IDs for the deployment targets.

createDeployment_command :: Lens' CreateDeployment DeploymentCommand Source #

A DeploymentCommand object that specifies the deployment command and any associated arguments.

createDeploymentResponse_deploymentId :: Lens' CreateDeploymentResponse (Maybe Text) Source #

The deployment ID, which can be used with other requests to identify the deployment.

AssignInstance

assignInstance_layerIds :: Lens' AssignInstance [Text] Source #

The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.

DescribeStacks

describeStacks_stackIds :: Lens' DescribeStacks (Maybe [Text]) Source #

An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.

describeStacksResponse_stacks :: Lens' DescribeStacksResponse (Maybe [Stack]) Source #

An array of Stack objects that describe the stacks.

DeleteInstance

deleteInstance_deleteVolumes :: Lens' DeleteInstance (Maybe Bool) Source #

Whether to delete the instance's Amazon EBS volumes.

deleteInstance_deleteElasticIp :: Lens' DeleteInstance (Maybe Bool) Source #

Whether to delete the instance Elastic IP address.

UpdateInstance

updateInstance_installUpdatesOnBoot :: Lens' UpdateInstance (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 by 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.

updateInstance_sshKeyName :: Lens' UpdateInstance (Maybe Text) Source #

The instance's Amazon EC2 key name.

updateInstance_agentVersion :: Lens' UpdateInstance (Maybe Text) Source #

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.
  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions.

AgentVersion cannot be set to Chef 12.2.

updateInstance_instanceType :: Lens' UpdateInstance (Maybe Text) Source #

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

updateInstance_ebsOptimized :: Lens' UpdateInstance (Maybe Bool) Source #

This property cannot be updated.

updateInstance_os :: Lens' UpdateInstance (Maybe Text) Source #

The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
  • CentOS Linux 7
  • Red Hat Enterprise Linux 7
  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.

updateInstance_autoScalingType :: Lens' UpdateInstance (Maybe AutoScalingType) Source #

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

updateInstance_architecture :: Lens' UpdateInstance (Maybe Architecture) Source #

The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

updateInstance_amiId :: Lens' UpdateInstance (Maybe Text) Source #

The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs.

DeregisterVolume

deregisterVolume_volumeId :: Lens' DeregisterVolume Text Source #

The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks Stacks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.

RebootInstance

DeleteApp

UpdateApp

updateApp_sslConfiguration :: Lens' UpdateApp (Maybe SslConfiguration) Source #

An SslConfiguration object with the SSL configuration.

updateApp_environment :: Lens' UpdateApp (Maybe [EnvironmentVariable]) Source #

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

updateApp_enableSsl :: Lens' UpdateApp (Maybe Bool) Source #

Whether SSL is enabled for the app.

updateApp_appSource :: Lens' UpdateApp (Maybe Source) Source #

A Source object that specifies the app repository.

updateApp_attributes :: Lens' UpdateApp (Maybe (HashMap AppAttributesKeys Text)) Source #

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

updateApp_domains :: Lens' UpdateApp (Maybe [Text]) Source #

The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

updateApp_description :: Lens' UpdateApp (Maybe Text) Source #

A description of the app.

UpdateRdsDbInstance

DescribeTimeBasedAutoScaling

describeTimeBasedAutoScalingResponse_timeBasedAutoScalingConfigurations :: Lens' DescribeTimeBasedAutoScalingResponse (Maybe [TimeBasedAutoScalingConfiguration]) Source #

An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.

StopStack

DescribeVolumes

describeVolumes_instanceId :: Lens' DescribeVolumes (Maybe Text) Source #

The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.

describeVolumes_volumeIds :: Lens' DescribeVolumes (Maybe [Text]) Source #

Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.

describeVolumes_raidArrayId :: Lens' DescribeVolumes (Maybe Text) Source #

The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.

describeVolumes_stackId :: Lens' DescribeVolumes (Maybe Text) Source #

A stack ID. The action describes the stack's registered Amazon EBS volumes.

DisassociateElasticIp

RegisterEcsCluster

StopInstance

stopInstance_force :: Lens' StopInstance (Maybe Bool) Source #

Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one.

RegisterVolume

SetTimeBasedAutoScaling

DescribeUserProfiles

describeUserProfiles_iamUserArns :: Lens' DescribeUserProfiles (Maybe [Text]) Source #

An array of IAM or federated user ARNs that identify the users to be described.

AttachElasticLoadBalancer

attachElasticLoadBalancer_layerId :: Lens' AttachElasticLoadBalancer Text Source #

The ID of the layer to which the Elastic Load Balancing instance is to be attached.

DeregisterElasticIp

DeregisterEcsCluster

deregisterEcsCluster_ecsClusterArn :: Lens' DeregisterEcsCluster Text Source #

The cluster's Amazon Resource Number (ARN).

DescribeApps

describeApps_appIds :: Lens' DescribeApps (Maybe [Text]) Source #

An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.

describeApps_stackId :: Lens' DescribeApps (Maybe Text) Source #

The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.

describeAppsResponse_apps :: Lens' DescribeAppsResponse (Maybe [App]) Source #

An array of App objects that describe the specified apps.

UpdateMyUserProfile

DescribeStackSummary

DescribeInstances

describeInstances_instanceIds :: Lens' DescribeInstances (Maybe [Text]) Source #

An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.

describeInstances_stackId :: Lens' DescribeInstances (Maybe Text) Source #

A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.

describeInstances_layerId :: Lens' DescribeInstances (Maybe Text) Source #

A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.

describeInstancesResponse_instances :: Lens' DescribeInstancesResponse (Maybe [Instance]) Source #

An array of Instance objects that describe the instances.

DescribeDeployments

describeDeployments_appId :: Lens' DescribeDeployments (Maybe Text) Source #

The app ID. If you include this parameter, the command returns a description of the commands associated with the specified app.

describeDeployments_deploymentIds :: Lens' DescribeDeployments (Maybe [Text]) Source #

An array of deployment IDs to be described. If you include this parameter, the command returns a description of the specified deployments. Otherwise, it returns a description of every deployment.

describeDeployments_stackId :: Lens' DescribeDeployments (Maybe Text) Source #

The stack ID. If you include this parameter, the command returns a description of the commands associated with the specified stack.

describeDeploymentsResponse_deployments :: Lens' DescribeDeploymentsResponse (Maybe [Deployment]) Source #

An array of Deployment objects that describe the deployments.

DescribeElasticIps

describeElasticIps_instanceId :: Lens' DescribeElasticIps (Maybe Text) Source #

The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.

describeElasticIps_ips :: Lens' DescribeElasticIps (Maybe [Text]) Source #

An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.

describeElasticIps_stackId :: Lens' DescribeElasticIps (Maybe Text) Source #

A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.

describeElasticIpsResponse_elasticIps :: Lens' DescribeElasticIpsResponse (Maybe [ElasticIp]) Source #

An ElasticIps object that describes the specified Elastic IP addresses.

GrantAccess

grantAccess_validForInMinutes :: Lens' GrantAccess (Maybe Natural) Source #

The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out.

grantAccess_instanceId :: Lens' GrantAccess Text Source #

The instance's AWS OpsWorks Stacks ID.

grantAccessResponse_temporaryCredential :: Lens' GrantAccessResponse (Maybe TemporaryCredential) Source #

A TemporaryCredential object that contains the data needed to log in to the instance by RDP clients, such as the Microsoft Remote Desktop Connection.

DeleteLayer

UpdateLayer

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.

CreateStack

createStack_defaultRootDeviceType :: Lens' CreateStack (Maybe RootDeviceType) Source #

The default root device type. This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store. For more information, see Storage for the Root Device.

createStack_vpcId :: Lens' CreateStack (Maybe Text) Source #

The ID of the VPC that the stack is to be launched into. The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

  • If your account supports EC2-Classic, the default value is no VPC.
  • If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

  • It must belong to a VPC in your account that is in the specified region.
  • You must specify a value for DefaultSubnetId.

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.

createStack_chefConfiguration :: Lens' CreateStack (Maybe ChefConfiguration) Source #

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

createStack_agentVersion :: Lens' CreateStack (Maybe Text) Source #

The default AWS OpsWorks Stacks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

createStack_defaultSshKeyName :: Lens' CreateStack (Maybe Text) Source #

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

createStack_customJson :: Lens' CreateStack (Maybe Text) Source #

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

createStack_customCookbooksSource :: Lens' CreateStack (Maybe Source) Source #

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

createStack_defaultAvailabilityZone :: Lens' CreateStack (Maybe Text) Source #

The stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

createStack_attributes :: Lens' CreateStack (Maybe (HashMap StackAttributesKeys (Maybe Text))) Source #

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

createStack_defaultOs :: Lens' CreateStack (Maybe Text) Source #

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance. You can specify one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
  • CentOS Linux 7
  • Red Hat Enterprise Linux 7
  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.

The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

createStack_useOpsworksSecurityGroups :: Lens' CreateStack (Maybe Bool) Source #

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
  • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

createStack_useCustomCookbooks :: Lens' CreateStack (Maybe Bool) Source #

Whether the stack uses custom cookbooks.

createStack_defaultSubnetId :: Lens' CreateStack (Maybe Text) Source #

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

createStack_configurationManager :: Lens' CreateStack (Maybe StackConfigurationManager) Source #

The configuration manager. When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

createStack_hostnameTheme :: Lens' CreateStack (Maybe Text) Source #

The stack's host name theme, with spaces replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods
  • Clouds
  • Europe_Cities
  • Fruits
  • Greek_Deities_and_Titans
  • Legendary_creatures_from_Japan
  • Planets_and_Moons
  • Roman_Deities
  • Scottish_Islands
  • US_Cities
  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

createStack_region :: Lens' CreateStack Text Source #

The stack's AWS region, such as ap-south-1. For more information about Amazon regions, see Regions and Endpoints.

In the AWS CLI, this API maps to the --stack-region parameter. If the --stack-region parameter and the AWS CLI common parameter --region are set to the same value, the stack uses a regional endpoint. If the --stack-region parameter is not set, but the AWS CLI --region parameter is, this also results in a stack with a regional endpoint. However, if the --region parameter is set to us-east-1, and the --stack-region parameter is set to one of the following, then the stack uses a legacy or classic region: us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2. In this case, the actual API endpoint of the stack is in us-east-1. Only the preceding regions are supported as classic regions in the us-east-1 API endpoint. Because it is a best practice to choose the regional endpoint that is closest to where you manage AWS, we recommend that you use regional endpoints for new stacks. The AWS CLI common --region parameter always specifies a regional API endpoint; it cannot be used to specify a classic AWS OpsWorks Stacks region.

createStack_serviceRoleArn :: Lens' CreateStack Text Source #

The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers.

createStack_defaultInstanceProfileArn :: Lens' CreateStack Text Source #

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

createStackResponse_stackId :: Lens' CreateStackResponse (Maybe Text) Source #

The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.

UpdateElasticIp

updateElasticIp_elasticIp :: Lens' UpdateElasticIp Text Source #

The IP address for which you want to update the name.

CreateApp

createApp_sslConfiguration :: Lens' CreateApp (Maybe SslConfiguration) Source #

An SslConfiguration object with the SSL configuration.

createApp_environment :: Lens' CreateApp (Maybe [EnvironmentVariable]) Source #

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."

If you have specified one or more environment variables, you cannot modify the stack's Chef version.

createApp_enableSsl :: Lens' CreateApp (Maybe Bool) Source #

Whether to enable SSL for the app.

createApp_appSource :: Lens' CreateApp (Maybe Source) Source #

A Source object that specifies the app repository.

createApp_attributes :: Lens' CreateApp (Maybe (HashMap AppAttributesKeys Text)) Source #

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

createApp_domains :: Lens' CreateApp (Maybe [Text]) Source #

The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'

createApp_description :: Lens' CreateApp (Maybe Text) Source #

A description of the app.

createApp_type :: Lens' CreateApp AppType Source #

The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify other.

createAppResponse_httpStatus :: Lens' CreateAppResponse Int Source #

The response's http status code.

GetHostnameSuggestion

CloneStack

cloneStack_defaultInstanceProfileArn :: Lens' CloneStack (Maybe Text) Source #

The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

cloneStack_cloneAppIds :: Lens' CloneStack (Maybe [Text]) Source #

A list of source stack app IDs to be included in the cloned stack.

cloneStack_defaultRootDeviceType :: Lens' CloneStack (Maybe RootDeviceType) Source #

The default root device type. This value is used by default for all instances in the cloned stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

cloneStack_vpcId :: Lens' CloneStack (Maybe Text) Source #

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances are launched into this VPC, and you cannot change the ID later.

  • If your account supports EC2 Classic, the default value is no VPC.
  • If your account does not support EC2 Classic, the default value is the default VPC for the specified region.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

  • It must belong to a VPC in your account that is in the specified region.
  • You must specify a value for DefaultSubnetId.

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms.

cloneStack_chefConfiguration :: Lens' CloneStack (Maybe ChefConfiguration) Source #

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see Create a New Stack.

cloneStack_agentVersion :: Lens' CloneStack (Maybe Text) Source #

The default AWS OpsWorks Stacks agent version. You have the following options:

  • Auto-update - Set this parameter to LATEST. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
  • Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.

The default setting is LATEST. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

cloneStack_defaultSshKeyName :: Lens' CloneStack (Maybe Text) Source #

A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.

cloneStack_customJson :: Lens' CloneStack (Maybe Text) Source #

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes

cloneStack_clonePermissions :: Lens' CloneStack (Maybe Bool) Source #

Whether to clone the source stack's permissions.

cloneStack_customCookbooksSource :: Lens' CloneStack (Maybe Source) Source #

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

cloneStack_defaultAvailabilityZone :: Lens' CloneStack (Maybe Text) Source #

The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints. If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

cloneStack_attributes :: Lens' CloneStack (Maybe (HashMap StackAttributesKeys (Maybe Text))) Source #

A list of stack attributes and values as key/value pairs to be added to the cloned stack.

cloneStack_name :: Lens' CloneStack (Maybe Text) Source #

The cloned stack name.

cloneStack_defaultOs :: Lens' CloneStack (Maybe Text) Source #

The stack's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.
  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.
  • CentOS Linux 7
  • Red Hat Enterprise Linux 7
  • Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.
  • A custom AMI: Custom. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

The default option is the parent stack's operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.

You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.

cloneStack_useOpsworksSecurityGroups :: Lens' CloneStack (Maybe Bool) Source #

Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

  • True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.
  • False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

cloneStack_useCustomCookbooks :: Lens' CloneStack (Maybe Bool) Source #

Whether to use custom cookbooks.

cloneStack_defaultSubnetId :: Lens' CloneStack (Maybe Text) Source #

The stack's default VPC subnet ID. This parameter is required if you specify a value for the VpcId parameter. All instances are launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for DefaultAvailabilityZone, the subnet must be in that zone. For information on default values and when this parameter is required, see the VpcId parameter description.

cloneStack_region :: Lens' CloneStack (Maybe Text) Source #

The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.

cloneStack_configurationManager :: Lens' CloneStack (Maybe StackConfigurationManager) Source #

The configuration manager. When you clone a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

cloneStack_hostnameTheme :: Lens' CloneStack (Maybe Text) Source #

The stack's host name theme, with spaces are replaced by underscores. The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent, which creates host names by appending integers to the layer's short name. The other themes are:

  • Baked_Goods
  • Clouds
  • Europe_Cities
  • Fruits
  • Greek_Deities_and_Titans
  • Legendary_creatures_from_Japan
  • Planets_and_Moons
  • Roman_Deities
  • Scottish_Islands
  • US_Cities
  • Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.

cloneStack_serviceRoleArn :: Lens' CloneStack Text Source #

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf. You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. If you create a stack by using the AWS OpsWorks Stacks console, it creates the role for you. You can obtain an existing stack's IAM ARN programmatically by calling DescribePermissions. For more information about IAM ARNs, see Using Identifiers.

You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.

DescribePermissions

describePermissions_iamUserArn :: Lens' DescribePermissions (Maybe Text) Source #

The user's IAM ARN. This can also be a federated user's ARN. For more information about IAM ARNs, see Using Identifiers.

describePermissionsResponse_permissions :: Lens' DescribePermissionsResponse (Maybe [Permission]) Source #

An array of Permission objects that describe the stack permissions.

  • If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs.
  • If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user's stack IDs.
  • If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN.

DetachElasticLoadBalancer

detachElasticLoadBalancer_layerId :: Lens' DetachElasticLoadBalancer Text Source #

The ID of the layer that the Elastic Load Balancing instance is attached to.

RegisterInstance

registerInstance_privateIp :: Lens' RegisterInstance (Maybe Text) Source #

The instance's private IP address.

registerInstance_instanceIdentity :: Lens' RegisterInstance (Maybe InstanceIdentity) Source #

An InstanceIdentity object that contains the instance's identity.

registerInstance_publicIp :: Lens' RegisterInstance (Maybe Text) Source #

The instance's public IP address.

registerInstance_rsaPublicKeyFingerprint :: Lens' RegisterInstance (Maybe Text) Source #

The instances public RSA key fingerprint.

registerInstance_rsaPublicKey :: Lens' RegisterInstance (Maybe Text) Source #

The instances public RSA key. This key is used to encrypt communication between the instance and the service.

registerInstance_stackId :: Lens' RegisterInstance Text Source #

The ID of the stack that the instance is to be registered with.

registerInstanceResponse_instanceId :: Lens' RegisterInstanceResponse (Maybe Text) Source #

The registered instance's AWS OpsWorks Stacks ID.

AssociateElasticIp

DescribeLoadBasedAutoScaling

describeLoadBasedAutoScalingResponse_loadBasedAutoScalingConfigurations :: Lens' DescribeLoadBasedAutoScalingResponse (Maybe [LoadBasedAutoScalingConfiguration]) Source #

An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.

DescribeStackProvisioningParameters

TagResource

tagResource_resourceArn :: Lens' TagResource Text Source #

The stack or layer's Amazon Resource Number (ARN).

tagResource_tags :: Lens' TagResource (HashMap Text Text) Source #

A map that contains tag keys and tag values that are attached to a stack or layer.

  • The key cannot be empty.
  • The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
  • The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
  • Leading and trailing white spaces are trimmed from both the key and value.
  • A maximum of 40 tags is allowed for any resource.

ListTags

listTags_nextToken :: Lens' ListTags (Maybe Text) Source #

Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call.

listTags_maxResults :: Lens' ListTags (Maybe Int) Source #

Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call.

listTags_resourceArn :: Lens' ListTags Text Source #

The stack or layer's Amazon Resource Number (ARN).

listTagsResponse_nextToken :: Lens' ListTagsResponse (Maybe Text) Source #

If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to get the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.

listTagsResponse_tags :: Lens' ListTagsResponse (Maybe (HashMap Text Text)) Source #

A set of key-value pairs that contain tag keys and tag values that are attached to a stack or layer.

listTagsResponse_httpStatus :: Lens' ListTagsResponse Int Source #

The response's http status code.

UnassignInstance

DescribeMyUserProfile

describeMyUserProfileResponse_userProfile :: Lens' DescribeMyUserProfileResponse (Maybe SelfUserProfile) Source #

A UserProfile object that describes the user's SSH information.

DeleteUserProfile

deleteUserProfile_iamUserArn :: Lens' DeleteUserProfile Text Source #

The user's IAM ARN. This can also be a federated user's ARN.

UpdateUserProfile

updateUserProfile_allowSelfManagement :: Lens' UpdateUserProfile (Maybe Bool) Source #

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

updateUserProfile_sshUsername :: Lens' UpdateUserProfile (Maybe Text) Source #

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

updateUserProfile_iamUserArn :: Lens' UpdateUserProfile Text Source #

The user IAM ARN. This can also be a federated user's ARN.

DescribeServiceErrors

describeServiceErrors_instanceId :: Lens' DescribeServiceErrors (Maybe Text) Source #

The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.

describeServiceErrors_stackId :: Lens' DescribeServiceErrors (Maybe Text) Source #

The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.

describeServiceErrors_serviceErrorIds :: Lens' DescribeServiceErrors (Maybe [Text]) Source #

An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.

describeServiceErrorsResponse_serviceErrors :: Lens' DescribeServiceErrorsResponse (Maybe [ServiceError]) Source #

An array of ServiceError objects that describe the specified service errors.

RegisterRdsDbInstance

UntagResource

untagResource_resourceArn :: Lens' UntagResource Text Source #

The stack or layer's Amazon Resource Number (ARN).

untagResource_tagKeys :: Lens' UntagResource [Text] Source #

A list of the keys of tags to be removed from a stack or layer.

StartStack

CreateUserProfile

createUserProfile_allowSelfManagement :: Lens' CreateUserProfile (Maybe Bool) Source #

Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.

createUserProfile_sshUsername :: Lens' CreateUserProfile (Maybe Text) Source #

The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name.

createUserProfile_iamUserArn :: Lens' CreateUserProfile Text Source #

The user's IAM ARN; this can also be a federated user's ARN.

DescribeOperatingSystems

describeOperatingSystemsResponse_operatingSystems :: Lens' DescribeOperatingSystemsResponse (Maybe [OperatingSystem]) Source #

Contains information in response to a DescribeOperatingSystems request.

DescribeCommands

describeCommands_deploymentId :: Lens' DescribeCommands (Maybe Text) Source #

The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.

describeCommands_instanceId :: Lens' DescribeCommands (Maybe Text) Source #

The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.

describeCommands_commandIds :: Lens' DescribeCommands (Maybe [Text]) Source #

An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.

describeCommandsResponse_commands :: Lens' DescribeCommandsResponse (Maybe [Command]) Source #

An array of Command objects that describe each of the specified commands.

AssignVolume

DescribeElasticLoadBalancers

describeElasticLoadBalancers_layerIds :: Lens' DescribeElasticLoadBalancers (Maybe [Text]) Source #

A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.

describeElasticLoadBalancers_stackId :: Lens' DescribeElasticLoadBalancers (Maybe Text) Source #

A stack ID. The action describes the stack's Elastic Load Balancing instances.

describeElasticLoadBalancersResponse_elasticLoadBalancers :: Lens' DescribeElasticLoadBalancersResponse (Maybe [ElasticLoadBalancer]) Source #

A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.

SetPermission

setPermission_allowSudo :: Lens' SetPermission (Maybe Bool) Source #

The user is allowed to use sudo to elevate privileges.

setPermission_level :: Lens' SetPermission (Maybe Text) Source #

The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.

  • deny
  • show
  • deploy
  • manage
  • iam_only

For more information about the permissions associated with these levels, see Managing User Permissions.

setPermission_allowSsh :: Lens' SetPermission (Maybe Bool) Source #

The user is allowed to use SSH to communicate with the instance.

setPermission_iamUserArn :: Lens' SetPermission Text Source #

The user's IAM ARN. This can also be a federated user's ARN.

DeregisterInstance

DescribeEcsClusters

describeEcsClusters_nextToken :: Lens' DescribeEcsClusters (Maybe Text) Source #

If the previous paginated request did not return all of the remaining results, the response object'sNextToken parameter value is set to a token. To retrieve the next set of results, call DescribeEcsClusters again and assign that token to the request object's NextToken parameter. If there are no remaining results, the previous response object's NextToken parameter is set to null.

describeEcsClusters_stackId :: Lens' DescribeEcsClusters (Maybe Text) Source #

A stack ID. DescribeEcsClusters returns a description of the cluster that is registered with the stack.

describeEcsClusters_maxResults :: Lens' DescribeEcsClusters (Maybe Int) Source #

To receive a paginated response, use this parameter to specify the maximum number of results to be returned with a single call. If the number of available results exceeds this maximum, the response includes a NextToken value that you can assign to the NextToken request parameter to get the next set of results.

describeEcsClusters_ecsClusterArns :: Lens' DescribeEcsClusters (Maybe [Text]) Source #

A list of ARNs, one for each cluster to be described.

describeEcsClustersResponse_nextToken :: Lens' DescribeEcsClustersResponse (Maybe Text) Source #

If a paginated request does not return all of the remaining results, this parameter is set to a token that you can assign to the request object's NextToken parameter to retrieve the next set of results. If the previous paginated request returned all of the remaining results, this parameter is set to null.

describeEcsClustersResponse_ecsClusters :: Lens' DescribeEcsClustersResponse (Maybe [EcsCluster]) Source #

A list of EcsCluster objects containing the cluster descriptions.

DescribeRaidArrays

describeRaidArrays_instanceId :: Lens' DescribeRaidArrays (Maybe Text) Source #

The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.

describeRaidArrays_raidArrayIds :: Lens' DescribeRaidArrays (Maybe [Text]) Source #

An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.

describeRaidArraysResponse_raidArrays :: Lens' DescribeRaidArraysResponse (Maybe [RaidArray]) Source #

A RaidArrays object that describes the specified RAID arrays.

UpdateVolume

StartInstance

Types

AgentVersion

App

app_sslConfiguration :: Lens' App (Maybe SslConfiguration) Source #

An SslConfiguration object with the SSL configuration.

app_environment :: Lens' App (Maybe [EnvironmentVariable]) Source #

An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.

There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.

app_enableSsl :: Lens' App (Maybe Bool) Source #

Whether to enable SSL for the app.

app_createdAt :: Lens' App (Maybe Text) Source #

When the app was created.

app_shortname :: Lens' App (Maybe Text) Source #

The app's short name.

app_dataSources :: Lens' App (Maybe [DataSource]) Source #

The app's data sources.

app_appSource :: Lens' App (Maybe Source) Source #

A Source object that describes the app repository.

app_appId :: Lens' App (Maybe Text) Source #

The app ID.

app_name :: Lens' App (Maybe Text) Source #

The app name.

app_type :: Lens' App (Maybe AppType) Source #

The app type.

app_stackId :: Lens' App (Maybe Text) Source #

The app stack ID.

app_domains :: Lens' App (Maybe [Text]) Source #

The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'

app_description :: Lens' App (Maybe Text) Source #

A description of the app.

AutoScalingThresholds

autoScalingThresholds_instanceCount :: Lens' AutoScalingThresholds (Maybe Int) Source #

The number of instances to add or remove when the load exceeds a threshold.

autoScalingThresholds_ignoreMetricsTime :: Lens' AutoScalingThresholds (Maybe Natural) Source #

The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.

autoScalingThresholds_loadThreshold :: Lens' AutoScalingThresholds (Maybe Double) Source #

The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing).

autoScalingThresholds_thresholdsWaitTime :: Lens' AutoScalingThresholds (Maybe Natural) Source #

The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.

autoScalingThresholds_alarms :: Lens' AutoScalingThresholds (Maybe [Text]) Source #

Custom Cloudwatch auto scaling alarms, to be used as thresholds. This parameter takes a list of up to five alarm names, which are case sensitive and must be in the same region as the stack.

To use custom alarms, you must update your service role to allow cloudwatch:DescribeAlarms. You can either have AWS OpsWorks Stacks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks Stacks to Act on Your Behalf.

autoScalingThresholds_memoryThreshold :: Lens' AutoScalingThresholds (Maybe Double) Source #

The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.

autoScalingThresholds_cpuThreshold :: Lens' AutoScalingThresholds (Maybe Double) Source #

The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.

BlockDeviceMapping

blockDeviceMapping_virtualName :: Lens' BlockDeviceMapping (Maybe Text) Source #

The virtual device name. For more information, see BlockDeviceMapping.

blockDeviceMapping_noDevice :: Lens' BlockDeviceMapping (Maybe Text) Source #

Suppresses the specified device included in the AMI's block device mapping.

blockDeviceMapping_ebs :: Lens' BlockDeviceMapping (Maybe EbsBlockDevice) Source #

An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.

blockDeviceMapping_deviceName :: Lens' BlockDeviceMapping (Maybe Text) Source #

The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks Stacks will provide the correct device name.

ChefConfiguration

CloudWatchLogsConfiguration

cloudWatchLogsConfiguration_enabled :: Lens' CloudWatchLogsConfiguration (Maybe Bool) Source #

Whether CloudWatch Logs is enabled for a layer.

CloudWatchLogsLogStream

cloudWatchLogsLogStream_batchCount :: Lens' CloudWatchLogsLogStream (Maybe Int) Source #

Specifies the max number of log events in a batch, up to 10000. The default value is 1000.

cloudWatchLogsLogStream_fileFingerprintLines :: Lens' CloudWatchLogsLogStream (Maybe Text) Source #

Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.

cloudWatchLogsLogStream_bufferDuration :: Lens' CloudWatchLogsLogStream (Maybe Int) Source #

Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.

cloudWatchLogsLogStream_batchSize :: Lens' CloudWatchLogsLogStream (Maybe Int) Source #

Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.

cloudWatchLogsLogStream_logGroupName :: Lens' CloudWatchLogsLogStream (Maybe Text) Source #

Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).

cloudWatchLogsLogStream_multiLineStartPattern :: Lens' CloudWatchLogsLogStream (Maybe Text) Source #

Specifies the pattern for identifying the start of a log message.

cloudWatchLogsLogStream_initialPosition :: Lens' CloudWatchLogsLogStream (Maybe CloudWatchLogsInitialPosition) Source #

Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.

cloudWatchLogsLogStream_datetimeFormat :: Lens' CloudWatchLogsLogStream (Maybe Text) Source #

Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.

cloudWatchLogsLogStream_encoding :: Lens' CloudWatchLogsLogStream (Maybe CloudWatchLogsEncoding) Source #

Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.

cloudWatchLogsLogStream_file :: Lens' CloudWatchLogsLogStream (Maybe Text) Source #

Specifies log files that you want to push to CloudWatch Logs.

File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group.

Zipped files are not supported.

Command

command_deploymentId :: Lens' Command (Maybe Text) Source #

The command deployment ID.

command_instanceId :: Lens' Command (Maybe Text) Source #

The ID of the instance where the command was executed.

command_status :: Lens' Command (Maybe Text) Source #

The command status:

  • failed
  • successful
  • skipped
  • pending

command_logUrl :: Lens' Command (Maybe Text) Source #

The URL of the command log.

command_createdAt :: Lens' Command (Maybe Text) Source #

Date and time when the command was run.

command_exitCode :: Lens' Command (Maybe Int) Source #

The command exit code.

command_type :: Lens' Command (Maybe Text) Source #

The command type:

  • configure
  • deploy
  • execute_recipes
  • install_dependencies
  • restart
  • rollback
  • setup
  • start
  • stop
  • undeploy
  • update_custom_cookbooks
  • update_dependencies

command_completedAt :: Lens' Command (Maybe Text) Source #

Date when the command completed.

command_acknowledgedAt :: Lens' Command (Maybe Text) Source #

Date and time when the command was acknowledged.

DataSource

dataSource_arn :: Lens' DataSource (Maybe Text) Source #

The data source's ARN.

dataSource_type :: Lens' DataSource (Maybe Text) Source #

The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, RdsDbInstance, or None.

Deployment

deployment_status :: Lens' Deployment (Maybe Text) Source #

The deployment status:

  • running
  • successful
  • failed

deployment_command :: Lens' Deployment (Maybe DeploymentCommand) Source #

Used to specify a stack or deployment command.

deployment_createdAt :: Lens' Deployment (Maybe Text) Source #

Date when the deployment was created.

deployment_customJson :: Lens' Deployment (Maybe Text) Source #

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

deployment_instanceIds :: Lens' Deployment (Maybe [Text]) Source #

The IDs of the target instances.

deployment_completedAt :: Lens' Deployment (Maybe Text) Source #

Date when the deployment completed.

deployment_comment :: Lens' Deployment (Maybe Text) Source #

A user-defined comment.

deployment_duration :: Lens' Deployment (Maybe Int) Source #

The deployment duration.

DeploymentCommand

deploymentCommand_args :: Lens' DeploymentCommand (Maybe (HashMap Text [Text])) Source #

The arguments of those commands that take arguments. It should be set to a JSON object with the following format:

{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}

The update_dependencies command takes two arguments:

  • upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as Amazon Linux 2016.09. You must also set the allow_reboot argument to true.
  • allow_reboot - Specifies whether to allow AWS OpsWorks Stacks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false.

For example, to upgrade an instance to Amazon Linux 2016.09, set Args to the following.

 { "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] }

deploymentCommand_name :: Lens' DeploymentCommand DeploymentCommandName Source #

Specifies the operation. You can specify only one command.

For stacks, the following commands are available:

  • execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {"recipes":["phpapp::appsetup"]}.
  • install_dependencies: Install the stack's dependencies.
  • update_custom_cookbooks: Update the stack's custom cookbooks.
  • update_dependencies: Update the stack's dependencies.

The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.

For apps, the following commands are available:

  • deploy: Deploy an app. Ruby on Rails apps have an optional Args parameter named migrate. Set Args to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}.
  • rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks Stacks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.
  • start: Start the app's web or application server.
  • stop: Stop the app's web or application server.
  • restart: Restart the app's web or application server.
  • undeploy: Undeploy the app.

EbsBlockDevice

ebsBlockDevice_deleteOnTermination :: Lens' EbsBlockDevice (Maybe Bool) Source #

Whether the volume is deleted on instance termination.

ebsBlockDevice_volumeSize :: Lens' EbsBlockDevice (Maybe Int) Source #

The volume size, in GiB. For more information, see EbsBlockDevice.

ebsBlockDevice_iops :: Lens' EbsBlockDevice (Maybe Int) Source #

The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.

ebsBlockDevice_volumeType :: Lens' EbsBlockDevice (Maybe VolumeType) Source #

The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, st1 for Throughput Optimized hard disk drives (HDD), sc1 for Cold HDD,and standard for Magnetic volumes.

If you specify the io1 volume type, you must also specify a value for the Iops attribute. The maximum ratio of provisioned IOPS to requested volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB) specified in the AMI attributes to set IOPS to 50 x (volume size).

EcsCluster

ecsCluster_registeredAt :: Lens' EcsCluster (Maybe Text) Source #

The time and date that the cluster was registered with the stack.

ElasticIp

elasticIp_instanceId :: Lens' ElasticIp (Maybe Text) Source #

The ID of the instance that the address is attached to.

elasticIp_region :: Lens' ElasticIp (Maybe Text) Source #

The AWS region. For more information, see Regions and Endpoints.

ElasticLoadBalancer

elasticLoadBalancer_subnetIds :: Lens' ElasticLoadBalancer (Maybe [Text]) Source #

A list of subnet IDs, if the stack is running in a VPC.

elasticLoadBalancer_stackId :: Lens' ElasticLoadBalancer (Maybe Text) Source #

The ID of the stack that the instance is associated with.

elasticLoadBalancer_ec2InstanceIds :: Lens' ElasticLoadBalancer (Maybe [Text]) Source #

A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.

elasticLoadBalancer_layerId :: Lens' ElasticLoadBalancer (Maybe Text) Source #

The ID of the layer that the instance is attached to.

EnvironmentVariable

environmentVariable_secure :: Lens' EnvironmentVariable (Maybe Bool) Source #

(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns *****FILTERED***** instead of the actual value. The default value for Secure is false.

environmentVariable_key :: Lens' EnvironmentVariable Text Source #

(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore.

environmentVariable_value :: Lens' EnvironmentVariable Text Source #

(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.

Instance

instance_privateDns :: Lens' Instance (Maybe Text) Source #

The instance's private DNS name.

instance_reportedAgentVersion :: Lens' Instance (Maybe Text) Source #

The instance's reported AWS OpsWorks Stacks agent version.

instance_status :: Lens' Instance (Maybe Text) Source #

The instance status:

  • booting
  • connection_lost
  • online
  • pending
  • rebooting
  • requested
  • running_setup
  • setup_failed
  • shutting_down
  • start_failed
  • stop_failed
  • stopped
  • stopping
  • terminated
  • terminating

instance_privateIp :: Lens' Instance (Maybe Text) Source #

The instance's private IP address.

instance_installUpdatesOnBoot :: Lens' Instance (Maybe Bool) Source #

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set 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.

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

instance_virtualizationType :: Lens' Instance (Maybe VirtualizationType) Source #

The instance's virtualization type: paravirtual or hvm.

instance_instanceProfileArn :: Lens' Instance (Maybe Text) Source #

The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.

instance_platform :: Lens' Instance (Maybe Text) Source #

The instance's platform.

instance_hostname :: Lens' Instance (Maybe Text) Source #

The instance host name.

instance_securityGroupIds :: Lens' Instance (Maybe [Text]) Source #

An array containing the instance security group IDs.

instance_ecsClusterArn :: Lens' Instance (Maybe Text) Source #

For container instances, the Amazon ECS cluster's ARN.

instance_arn :: Lens' Instance (Maybe Text) Source #

The instance's Amazon Resource Number (ARN).

instance_createdAt :: Lens' Instance (Maybe Text) Source #

The time that the instance was created.

instance_ec2InstanceId :: Lens' Instance (Maybe Text) Source #

The ID of the associated Amazon EC2 instance.

instance_sshKeyName :: Lens' Instance (Maybe Text) Source #

The instance's Amazon EC2 key-pair name.

instance_agentVersion :: Lens' Instance (Maybe Text) Source #

The agent version. This parameter is set to INHERIT if the instance inherits the default stack setting or to a a version number for a fixed agent version.

instance_subnetId :: Lens' Instance (Maybe Text) Source #

The instance's subnet ID; applicable only if the stack is running in a VPC.

instance_infrastructureClass :: Lens' Instance (Maybe Text) Source #

For registered instances, the infrastructure class: ec2 or on-premises.

instance_sshHostDsaKeyFingerprint :: Lens' Instance (Maybe Text) Source #

The SSH key's Deep Security Agent (DSA) fingerprint.

instance_instanceType :: Lens' Instance (Maybe Text) Source #

The instance type, such as t2.micro.

instance_ebsOptimized :: Lens' Instance (Maybe Bool) Source #

Whether this is an Amazon EBS-optimized instance.

instance_os :: Lens' Instance (Maybe Text) Source #

The instance's operating system.

instance_availabilityZone :: Lens' Instance (Maybe Text) Source #

The instance Availability Zone. For more information, see Regions and Endpoints.

instance_lastServiceErrorId :: Lens' Instance (Maybe Text) Source #

The ID of the last service error. For more information, call DescribeServiceErrors.

instance_tenancy :: Lens' Instance (Maybe Text) Source #

The instance's tenancy option, such as dedicated or host.

instance_autoScalingType :: Lens' Instance (Maybe AutoScalingType) Source #

For load-based or time-based instances, the type.

instance_layerIds :: Lens' Instance (Maybe [Text]) Source #

An array containing the instance layer IDs.

instance_architecture :: Lens' Instance (Maybe Architecture) Source #

The instance architecture: "i386" or "x86_64".

instance_publicDns :: Lens' Instance (Maybe Text) Source #

The instance public DNS name.

instance_amiId :: Lens' Instance (Maybe Text) Source #

A custom AMI ID to be used to create the instance. For more information, see Instances

instance_publicIp :: Lens' Instance (Maybe Text) Source #

The instance public IP address.

instance_reportedOs :: Lens' Instance (Maybe ReportedOs) Source #

For registered instances, the reported operating system.

instance_registeredBy :: Lens' Instance (Maybe Text) Source #

For registered instances, who performed the registration.

instance_rootDeviceType :: Lens' Instance (Maybe RootDeviceType) Source #

The instance's root device type. For more information, see Storage for the Root Device.

instance_ecsContainerInstanceArn :: Lens' Instance (Maybe Text) Source #

For container instances, the instance's ARN.

instance_blockDeviceMappings :: Lens' Instance (Maybe [BlockDeviceMapping]) Source #

An array of BlockDeviceMapping objects that specify the instance's block device mappings.

InstanceIdentity

instanceIdentity_signature :: Lens' InstanceIdentity (Maybe Text) Source #

A signature that can be used to verify the document's accuracy and authenticity.

instanceIdentity_document :: Lens' InstanceIdentity (Maybe Text) Source #

A JSON document that contains the metadata.

InstancesCount

instancesCount_terminating :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with terminating status.

instancesCount_pending :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with pending status.

instancesCount_online :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with online status.

instancesCount_unassigning :: Lens' InstancesCount (Maybe Int) Source #

The number of instances in the Unassigning state.

instancesCount_deregistering :: Lens' InstancesCount (Maybe Int) Source #

The number of instances in the Deregistering state.

instancesCount_runningSetup :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with running_setup status.

instancesCount_requested :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with requested status.

instancesCount_stopFailed :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with stop_failed status.

instancesCount_booting :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with booting status.

instancesCount_stopped :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with stopped status.

instancesCount_rebooting :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with rebooting status.

instancesCount_assigning :: Lens' InstancesCount (Maybe Int) Source #

The number of instances in the Assigning state.

instancesCount_shuttingDown :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with shutting_down status.

instancesCount_setupFailed :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with setup_failed status.

instancesCount_connectionLost :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with connection_lost status.

instancesCount_terminated :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with terminated status.

instancesCount_stopping :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with stopping status.

instancesCount_registered :: Lens' InstancesCount (Maybe Int) Source #

The number of instances in the Registered state.

instancesCount_startFailed :: Lens' InstancesCount (Maybe Int) Source #

The number of instances with start_failed status.

instancesCount_registering :: Lens' InstancesCount (Maybe Int) Source #

The number of instances in the Registering state.

Layer

layer_customInstanceProfileArn :: Lens' Layer (Maybe Text) Source #

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

layer_customSecurityGroupIds :: Lens' Layer (Maybe [Text]) Source #

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

layer_installUpdatesOnBoot :: Lens' Layer (Maybe Bool) Source #

Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set 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.

layer_cloudWatchLogsConfiguration :: Lens' Layer (Maybe CloudWatchLogsConfiguration) Source #

The Amazon CloudWatch Logs configuration settings for the layer.

layer_lifecycleEventConfiguration :: Lens' Layer (Maybe LifecycleEventConfiguration) Source #

A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.

layer_arn :: Lens' Layer (Maybe Text) Source #

The Amazon Resource Number (ARN) of a layer.

layer_createdAt :: Lens' Layer (Maybe Text) Source #

Date when the layer was created.

layer_shortname :: Lens' Layer (Maybe Text) Source #

The layer short name.

layer_defaultRecipes :: Lens' Layer (Maybe Recipes) Source #

AWS OpsWorks Stacks supports five lifecycle events: setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks Stacks runs a set of standard recipes for each event. You can also provide custom recipes for any or all layers and events. AWS OpsWorks Stacks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.

To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.

layer_customRecipes :: Lens' Layer (Maybe Recipes) Source #

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

layer_customJson :: Lens' Layer (Maybe Text) Source #

A JSON formatted string containing the layer's custom stack configuration and deployment attributes.

layer_volumeConfigurations :: Lens' Layer (Maybe [VolumeConfiguration]) Source #

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

layer_enableAutoHealing :: Lens' Layer (Maybe Bool) Source #

Whether auto healing is disabled for the layer.

layer_packages :: Lens' Layer (Maybe [Text]) Source #

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

layer_attributes :: Lens' Layer (Maybe (HashMap LayerAttributesKeys (Maybe Text))) Source #

The layer attributes.

For the HaproxyStatsPassword, MysqlRootPassword, and GangliaPassword attributes, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value

For an ECS Cluster layer, AWS OpsWorks Stacks the EcsClusterArn attribute is set to the cluster's ARN.

layer_name :: Lens' Layer (Maybe Text) Source #

The layer name.

layer_autoAssignPublicIps :: Lens' Layer (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.

layer_useEbsOptimizedInstances :: Lens' Layer (Maybe Bool) Source #

Whether the layer uses Amazon EBS-optimized instances.

layer_stackId :: Lens' Layer (Maybe Text) Source #

The layer stack ID.

layer_defaultSecurityGroupNames :: Lens' Layer (Maybe [Text]) Source #

An array containing the layer's security group names.

layer_autoAssignElasticIps :: Lens' Layer (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.

LifecycleEventConfiguration

lifecycleEventConfiguration_shutdown :: Lens' LifecycleEventConfiguration (Maybe ShutdownEventConfiguration) Source #

A ShutdownEventConfiguration object that specifies the Shutdown event configuration.

LoadBasedAutoScalingConfiguration

loadBasedAutoScalingConfiguration_upScaling :: Lens' LoadBasedAutoScalingConfiguration (Maybe AutoScalingThresholds) Source #

An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks Stacks increases the number of instances.

loadBasedAutoScalingConfiguration_enable :: Lens' LoadBasedAutoScalingConfiguration (Maybe Bool) Source #

Whether load-based auto scaling is enabled for the layer.

loadBasedAutoScalingConfiguration_downScaling :: Lens' LoadBasedAutoScalingConfiguration (Maybe AutoScalingThresholds) Source #

An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks Stacks reduces the number of instances.

OperatingSystem

operatingSystem_reportedVersion :: Lens' OperatingSystem (Maybe Text) Source #

The version of the operating system, including the release and edition, if applicable.

operatingSystem_supported :: Lens' OperatingSystem (Maybe Bool) Source #

Indicates that an operating system is not supported for new instances.

operatingSystem_name :: Lens' OperatingSystem (Maybe Text) Source #

The name of the operating system, such as Amazon Linux 2018.03.

operatingSystem_id :: Lens' OperatingSystem (Maybe Text) Source #

The ID of a supported operating system, such as Amazon Linux 2018.03.

operatingSystem_configurationManagers :: Lens' OperatingSystem (Maybe [OperatingSystemConfigurationManager]) Source #

Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.

operatingSystem_type :: Lens' OperatingSystem (Maybe Text) Source #

The type of a supported operating system, either Linux or Windows.

operatingSystem_reportedName :: Lens' OperatingSystem (Maybe Text) Source #

A short name for the operating system manufacturer.

OperatingSystemConfigurationManager

operatingSystemConfigurationManager_name :: Lens' OperatingSystemConfigurationManager (Maybe Text) Source #

The name of the configuration manager, which is Chef.

operatingSystemConfigurationManager_version :: Lens' OperatingSystemConfigurationManager (Maybe Text) Source #

The versions of the configuration manager that are supported by an operating system.

Permission

permission_iamUserArn :: Lens' Permission (Maybe Text) Source #

The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.

permission_allowSudo :: Lens' Permission (Maybe Bool) Source #

Whether the user can use sudo.

permission_level :: Lens' Permission (Maybe Text) Source #

The user's permission level, which must be the following:

  • deny
  • show
  • deploy
  • manage
  • iam_only

For more information on the permissions associated with these levels, see Managing User Permissions

permission_allowSsh :: Lens' Permission (Maybe Bool) Source #

Whether the user can use SSH.

RaidArray

raidArray_iops :: Lens' RaidArray (Maybe Int) Source #

For PIOPS volumes, the IOPS per disk.

raidArray_createdAt :: Lens' RaidArray (Maybe Text) Source #

When the RAID array was created.

raidArray_device :: Lens' RaidArray (Maybe Text) Source #

The array's Linux device. For example /dev/mdadm0.

raidArray_numberOfDisks :: Lens' RaidArray (Maybe Int) Source #

The number of disks in the array.

raidArray_availabilityZone :: Lens' RaidArray (Maybe Text) Source #

The array's Availability Zone. For more information, see Regions and Endpoints.

raidArray_volumeType :: Lens' RaidArray (Maybe Text) Source #

The volume type, standard or PIOPS.

raidArray_mountPoint :: Lens' RaidArray (Maybe Text) Source #

The array's mount point.

RdsDbInstance

rdsDbInstance_missingOnRds :: Lens' RdsDbInstance (Maybe Bool) Source #

Set to true if AWS OpsWorks Stacks is unable to discover the Amazon RDS instance. AWS OpsWorks Stacks attempts to discover the instance only once. If this value is set to true, you must deregister the instance, and then register it again.

rdsDbInstance_engine :: Lens' RdsDbInstance (Maybe Text) Source #

The instance's database engine.

rdsDbInstance_region :: Lens' RdsDbInstance (Maybe Text) Source #

The instance's AWS region.

rdsDbInstance_stackId :: Lens' RdsDbInstance (Maybe Text) Source #

The ID of the stack with which the instance is registered.

rdsDbInstance_dbPassword :: Lens' RdsDbInstance (Maybe Text) Source #

AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

Recipes

recipes_setup :: Lens' Recipes (Maybe [Text]) Source #

An array of custom recipe names to be run following a setup event.

recipes_shutdown :: Lens' Recipes (Maybe [Text]) Source #

An array of custom recipe names to be run following a shutdown event.

recipes_undeploy :: Lens' Recipes (Maybe [Text]) Source #

An array of custom recipe names to be run following a undeploy event.

recipes_configure :: Lens' Recipes (Maybe [Text]) Source #

An array of custom recipe names to be run following a configure event.

recipes_deploy :: Lens' Recipes (Maybe [Text]) Source #

An array of custom recipe names to be run following a deploy event.

ReportedOs

reportedOs_family :: Lens' ReportedOs (Maybe Text) Source #

The operating system family.

reportedOs_name :: Lens' ReportedOs (Maybe Text) Source #

The operating system name.

reportedOs_version :: Lens' ReportedOs (Maybe Text) Source #

The operating system version.

SelfUserProfile

ServiceError

serviceError_message :: Lens' ServiceError (Maybe Text) Source #

A message that describes the error.

ShutdownEventConfiguration

shutdownEventConfiguration_executionTimeout :: Lens' ShutdownEventConfiguration (Maybe Int) Source #

The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.

shutdownEventConfiguration_delayUntilElbConnectionsDrained :: Lens' ShutdownEventConfiguration (Maybe Bool) Source #

Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining

Source

source_url :: Lens' Source (Maybe Text) Source #

The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.

source_username :: Lens' Source (Maybe Text) Source #

This parameter depends on the repository type.

  • For Amazon S3 bundles, set Username to the appropriate IAM access key ID.
  • For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.

source_sshKey :: Lens' Source (Maybe Text) Source #

In requests, the repository's SSH key.

In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

source_password :: Lens' Source (Maybe Text) Source #

When included in a request, the parameter depends on the repository type.

  • For Amazon S3 bundles, set Password to the appropriate IAM secret access key.
  • For HTTP bundles and Subversion repositories, set Password to the password.

For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

source_type :: Lens' Source (Maybe SourceType) Source #

The repository type.

source_revision :: Lens' Source (Maybe Text) Source #

The application's version. AWS OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

SslConfiguration

sslConfiguration_privateKey :: Lens' SslConfiguration (Maybe Text) Source #

The private key; the contents of the certificate's domain.kex file.

sslConfiguration_certificate :: Lens' SslConfiguration (Maybe Text) Source #

The contents of the certificate's domain.crt file.

sslConfiguration_chain :: Lens' SslConfiguration (Maybe Text) Source #

Optional. Can be used to specify an intermediate certificate authority key or client authentication.

Stack

stack_defaultInstanceProfileArn :: Lens' Stack (Maybe Text) Source #

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

stack_serviceRoleArn :: Lens' Stack (Maybe Text) Source #

The stack AWS Identity and Access Management (IAM) role.

stack_defaultRootDeviceType :: Lens' Stack (Maybe RootDeviceType) Source #

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

stack_arn :: Lens' Stack (Maybe Text) Source #

The stack's ARN.

stack_createdAt :: Lens' Stack (Maybe Text) Source #

The date when the stack was created.

stack_vpcId :: Lens' Stack (Maybe Text) Source #

The VPC ID; applicable only if the stack is running in a VPC.

stack_chefConfiguration :: Lens' Stack (Maybe ChefConfiguration) Source #

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

stack_agentVersion :: Lens' Stack (Maybe Text) Source #

The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

stack_defaultSshKeyName :: Lens' Stack (Maybe Text) Source #

A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

stack_customJson :: Lens' Stack (Maybe Text) Source #

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values or to pass data to recipes. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

stack_customCookbooksSource :: Lens' Stack (Maybe Source) Source #

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

stack_defaultAvailabilityZone :: Lens' Stack (Maybe Text) Source #

The stack's default Availability Zone. For more information, see Regions and Endpoints.

stack_name :: Lens' Stack (Maybe Text) Source #

The stack name.

stack_defaultOs :: Lens' Stack (Maybe Text) Source #

The stack's default operating system.

stack_useOpsworksSecurityGroups :: Lens' Stack (Maybe Bool) Source #

Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.

stack_useCustomCookbooks :: Lens' Stack (Maybe Bool) Source #

Whether the stack uses custom cookbooks.

stack_defaultSubnetId :: Lens' Stack (Maybe Text) Source #

The default subnet ID; applicable only if the stack is running in a VPC.

stack_region :: Lens' Stack (Maybe Text) Source #

The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.

stack_hostnameTheme :: Lens' Stack (Maybe Text) Source #

The stack host name theme, with spaces replaced by underscores.

StackConfigurationManager

stackConfigurationManager_name :: Lens' StackConfigurationManager (Maybe Text) Source #

The name. This parameter must be set to "Chef".

stackConfigurationManager_version :: Lens' StackConfigurationManager (Maybe Text) Source #

The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 11.4.

StackSummary

stackSummary_instancesCount :: Lens' StackSummary (Maybe InstancesCount) Source #

An InstancesCount object with the number of instances in each status.

TemporaryCredential

temporaryCredential_instanceId :: Lens' TemporaryCredential (Maybe Text) Source #

The instance's AWS OpsWorks Stacks ID.

temporaryCredential_validForInMinutes :: Lens' TemporaryCredential (Maybe Int) Source #

The length of time (in minutes) that the grant is valid. When the grant expires, at the end of this period, the user will no longer be able to use the credentials to log in. If they are logged in at the time, they will be automatically logged out.

TimeBasedAutoScalingConfiguration

UserProfile

userProfile_allowSelfManagement :: Lens' UserProfile (Maybe Bool) Source #

Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.

Volume

volume_size :: Lens' Volume (Maybe Int) Source #

The volume size.

volume_iops :: Lens' Volume (Maybe Int) Source #

For PIOPS volumes, the IOPS per disk.

volume_device :: Lens' Volume (Maybe Text) Source #

The device name.

volume_encrypted :: Lens' Volume (Maybe Bool) Source #

Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

volume_availabilityZone :: Lens' Volume (Maybe Text) Source #

The volume Availability Zone. For more information, see Regions and Endpoints.

volume_name :: Lens' Volume (Maybe Text) Source #

The volume name.

volume_region :: Lens' Volume (Maybe Text) Source #

The AWS region. For more information about AWS regions, see Regions and Endpoints.

volume_volumeType :: Lens' Volume (Maybe Text) Source #

The volume type. For more information, see Amazon EBS Volume Types.

  • standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.
  • io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.
  • gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.
  • st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.
  • sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

volume_ec2VolumeId :: Lens' Volume (Maybe Text) Source #

The Amazon EC2 volume ID.

volume_mountPoint :: Lens' Volume (Maybe Text) Source #

The volume mount point. For example, "/mnt/disk1".

VolumeConfiguration

volumeConfiguration_iops :: Lens' VolumeConfiguration (Maybe Int) Source #

For PIOPS volumes, the IOPS per disk.

volumeConfiguration_encrypted :: Lens' VolumeConfiguration (Maybe Bool) Source #

Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.

volumeConfiguration_volumeType :: Lens' VolumeConfiguration (Maybe Text) Source #

The volume type. For more information, see Amazon EBS Volume Types.

  • standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.
  • io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.
  • gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.
  • st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.
  • sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.

volumeConfiguration_mountPoint :: Lens' VolumeConfiguration Text Source #

The volume mount point. For example "/dev/sdh".

WeeklyAutoScalingSchedule