| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.OpsWorks
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- DescribeRDSDBInstances
- DeleteStack
- UpdateStack
- CreateLayer
- SetLoadBasedAutoScaling
- DeregisterRDSDBInstance
- UnassignVolume
- CreateInstance
- DescribeLayers
- RegisterElasticIP
- DescribeAgentVersions
- CreateDeployment
- AssignInstance
- DescribeStacks
- DeleteInstance
- UpdateInstance
- DeregisterVolume
- RebootInstance
- DeleteApp
- UpdateApp
- UpdateRDSDBInstance
- DescribeTimeBasedAutoScaling
- StopStack
- DescribeVolumes
- DisassociateElasticIP
- RegisterEcsCluster
- StopInstance
- RegisterVolume
- SetTimeBasedAutoScaling
- DescribeUserProfiles
- AttachElasticLoadBalancer
- DeregisterElasticIP
- DeregisterEcsCluster
- DescribeApps
- UpdateMyUserProfile
- DescribeStackSummary
- DescribeInstances
- DescribeDeployments
- DescribeElasticIPs
- GrantAccess
- DeleteLayer
- UpdateLayer
- CreateStack
- UpdateElasticIP
- CreateApp
- GetHostnameSuggestion
- CloneStack
- DescribePermissions
- DetachElasticLoadBalancer
- RegisterInstance
- AssociateElasticIP
- DescribeLoadBasedAutoScaling
- DescribeStackProvisioningParameters
- TagResource
- ListTags
- UnassignInstance
- DescribeMyUserProfile
- DeleteUserProfile
- UpdateUserProfile
- DescribeServiceErrors
- RegisterRDSDBInstance
- UntagResource
- StartStack
- CreateUserProfile
- DescribeOperatingSystems
- DescribeCommands
- AssignVolume
- DescribeElasticLoadBalancers
- SetPermission
- DeregisterInstance
- DescribeEcsClusters (Paginated)
- DescribeRAIdArrays
- UpdateVolume
- StartInstance
- Types
- AppAttributesKeys
- AppType
- Architecture
- AutoScalingType
- CloudWatchLogsEncoding
- CloudWatchLogsInitialPosition
- CloudWatchLogsTimeZone
- DeploymentCommandName
- LayerAttributesKeys
- LayerType
- RootDeviceType
- SourceType
- StackAttributesKeys
- VirtualizationType
- VolumeType
- AgentVersion
- App
- AutoScalingThresholds
- BlockDeviceMapping
- ChefConfiguration
- CloudWatchLogsConfiguration
- CloudWatchLogsLogStream
- Command
- DataSource
- Deployment
- DeploymentCommand
- EBSBlockDevice
- EcsCluster
- ElasticIP
- ElasticLoadBalancer
- EnvironmentVariable
- Instance
- InstanceIdentity
- InstancesCount
- Layer
- LifecycleEventConfiguration
- LoadBasedAutoScalingConfiguration
- OperatingSystem
- OperatingSystemConfigurationManager
- Permission
- RAIdArray
- RDSDBInstance
- Recipes
- ReportedOS
- SSLConfiguration
- SelfUserProfile
- ServiceError'
- ShutdownEventConfiguration
- Source
- Stack
- StackConfigurationManager
- StackSummary
- TemporaryCredential
- TimeBasedAutoScalingConfiguration
- UserProfile
- Volume
- VolumeConfiguration
- WeeklyAutoScalingSchedule
Description
AWS OpsWorks
Welcome to the AWS OpsWorks Stacks API Reference . This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.
AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page.
SDKs and CLI
The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see:
- AWS CLI
- AWS SDK for Java
- AWS SDK for .NET
- AWS SDK for PHP 2
- AWS SDK for Ruby
- AWS SDK for Node.js
- AWS SDK for Python(Boto)
Endpoints
AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created.
- opsworks.us-east-1.amazonaws.com
- opsworks.us-east-2.amazonaws.com
- opsworks.us-west-1.amazonaws.com
- opsworks.us-west-2.amazonaws.com
- opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console)
- opsworks.eu-west-1.amazonaws.com
- opsworks.eu-west-2.amazonaws.com
- opsworks.eu-west-3.amazonaws.com
- opsworks.eu-central-1.amazonaws.com
- opsworks.ap-northeast-1.amazonaws.com
- opsworks.ap-northeast-2.amazonaws.com
- opsworks.ap-south-1.amazonaws.com
- opsworks.ap-southeast-1.amazonaws.com
- opsworks.ap-southeast-2.amazonaws.com
- opsworks.sa-east-1.amazonaws.com
Chef Versions
When you call CreateStack , CloneStack , or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions .
Synopsis
- opsWorks :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- instanceTerminated :: Wait DescribeInstances
- deploymentSuccessful :: Wait DescribeDeployments
- instanceStopped :: Wait DescribeInstances
- instanceOnline :: Wait DescribeInstances
- appExists :: Wait DescribeApps
- instanceRegistered :: Wait DescribeInstances
- module Network.AWS.OpsWorks.DescribeRDSDBInstances
- module Network.AWS.OpsWorks.DeleteStack
- module Network.AWS.OpsWorks.UpdateStack
- module Network.AWS.OpsWorks.CreateLayer
- module Network.AWS.OpsWorks.SetLoadBasedAutoScaling
- module Network.AWS.OpsWorks.DeregisterRDSDBInstance
- module Network.AWS.OpsWorks.UnassignVolume
- module Network.AWS.OpsWorks.CreateInstance
- module Network.AWS.OpsWorks.DescribeLayers
- module Network.AWS.OpsWorks.RegisterElasticIP
- module Network.AWS.OpsWorks.DescribeAgentVersions
- module Network.AWS.OpsWorks.CreateDeployment
- module Network.AWS.OpsWorks.AssignInstance
- module Network.AWS.OpsWorks.DescribeStacks
- module Network.AWS.OpsWorks.DeleteInstance
- module Network.AWS.OpsWorks.UpdateInstance
- module Network.AWS.OpsWorks.DeregisterVolume
- module Network.AWS.OpsWorks.RebootInstance
- module Network.AWS.OpsWorks.DeleteApp
- module Network.AWS.OpsWorks.UpdateApp
- module Network.AWS.OpsWorks.UpdateRDSDBInstance
- module Network.AWS.OpsWorks.DescribeTimeBasedAutoScaling
- module Network.AWS.OpsWorks.StopStack
- module Network.AWS.OpsWorks.DescribeVolumes
- module Network.AWS.OpsWorks.DisassociateElasticIP
- module Network.AWS.OpsWorks.RegisterEcsCluster
- module Network.AWS.OpsWorks.StopInstance
- module Network.AWS.OpsWorks.RegisterVolume
- module Network.AWS.OpsWorks.SetTimeBasedAutoScaling
- module Network.AWS.OpsWorks.DescribeUserProfiles
- module Network.AWS.OpsWorks.AttachElasticLoadBalancer
- module Network.AWS.OpsWorks.DeregisterElasticIP
- module Network.AWS.OpsWorks.DeregisterEcsCluster
- module Network.AWS.OpsWorks.DescribeApps
- module Network.AWS.OpsWorks.UpdateMyUserProfile
- module Network.AWS.OpsWorks.DescribeStackSummary
- module Network.AWS.OpsWorks.DescribeInstances
- module Network.AWS.OpsWorks.DescribeDeployments
- module Network.AWS.OpsWorks.DescribeElasticIPs
- module Network.AWS.OpsWorks.GrantAccess
- module Network.AWS.OpsWorks.DeleteLayer
- module Network.AWS.OpsWorks.UpdateLayer
- module Network.AWS.OpsWorks.CreateStack
- module Network.AWS.OpsWorks.UpdateElasticIP
- module Network.AWS.OpsWorks.CreateApp
- module Network.AWS.OpsWorks.GetHostnameSuggestion
- module Network.AWS.OpsWorks.CloneStack
- module Network.AWS.OpsWorks.DescribePermissions
- module Network.AWS.OpsWorks.DetachElasticLoadBalancer
- module Network.AWS.OpsWorks.RegisterInstance
- module Network.AWS.OpsWorks.AssociateElasticIP
- module Network.AWS.OpsWorks.DescribeLoadBasedAutoScaling
- module Network.AWS.OpsWorks.DescribeStackProvisioningParameters
- module Network.AWS.OpsWorks.TagResource
- module Network.AWS.OpsWorks.ListTags
- module Network.AWS.OpsWorks.UnassignInstance
- module Network.AWS.OpsWorks.DescribeMyUserProfile
- module Network.AWS.OpsWorks.DeleteUserProfile
- module Network.AWS.OpsWorks.UpdateUserProfile
- module Network.AWS.OpsWorks.DescribeServiceErrors
- module Network.AWS.OpsWorks.RegisterRDSDBInstance
- module Network.AWS.OpsWorks.UntagResource
- module Network.AWS.OpsWorks.StartStack
- module Network.AWS.OpsWorks.CreateUserProfile
- module Network.AWS.OpsWorks.DescribeOperatingSystems
- module Network.AWS.OpsWorks.DescribeCommands
- module Network.AWS.OpsWorks.AssignVolume
- module Network.AWS.OpsWorks.DescribeElasticLoadBalancers
- module Network.AWS.OpsWorks.SetPermission
- module Network.AWS.OpsWorks.DeregisterInstance
- module Network.AWS.OpsWorks.DescribeEcsClusters
- module Network.AWS.OpsWorks.DescribeRAIdArrays
- module Network.AWS.OpsWorks.UpdateVolume
- module Network.AWS.OpsWorks.StartInstance
- data AppAttributesKeys
- data AppType
- data Architecture
- data AutoScalingType
- data CloudWatchLogsEncoding
- = Ascii
- | BIG5
- | Big5hkscs
- | CP037
- | CP1006
- | CP1026
- | CP1140
- | CP1250
- | CP1251
- | CP1252
- | CP1253
- | CP1254
- | CP1255
- | CP1256
- | CP1257
- | CP1258
- | CP424
- | CP437
- | CP500
- | CP720
- | CP737
- | CP775
- | CP850
- | CP852
- | CP855
- | CP856
- | CP857
- | CP858
- | CP860
- | CP861
- | CP862
- | CP863
- | CP864
- | CP865
- | CP866
- | CP869
- | CP874
- | CP875
- | CP932
- | CP949
- | CP950
- | EucJISX0213
- | EucJis2004
- | EucJp
- | EucKr
- | GB18030
- | GB2312
- | Gbk
- | HZ
- | ISO2022Jp
- | ISO2022Jp1
- | ISO2022Jp2
- | ISO2022Jp2004
- | ISO2022Jp3
- | ISO2022JpExt
- | ISO2022Kr
- | ISO885910
- | ISO885913
- | ISO885914
- | ISO885915
- | ISO885916
- | ISO88592
- | ISO88593
- | ISO88594
- | ISO88595
- | ISO88596
- | ISO88597
- | ISO88598
- | ISO88599
- | Johab
- | KOI8r
- | KOI8u
- | Latin1
- | MACCyrillic
- | MACGreek
- | MACIceland
- | MACLATIN2
- | MACRoman
- | MACTurkish
- | PTCP154
- | ShiftJISX0213
- | ShiftJis
- | ShiftJis2004
- | Utf16
- | Utf16Be
- | Utf16Le
- | Utf32
- | Utf32Be
- | Utf32Le
- | Utf7
- | Utf8
- | Utf8Sig
- data CloudWatchLogsInitialPosition
- data CloudWatchLogsTimeZone
- data DeploymentCommandName
- data LayerAttributesKeys
- = BundlerVersion
- | EcsClusterARN
- | EnableHaproxyStats
- | GangliaPassword
- | GangliaURL
- | GangliaUser
- | HaproxyHealthCheckMethod
- | HaproxyHealthCheckURL
- | HaproxyStatsPassword
- | HaproxyStatsURL
- | HaproxyStatsUser
- | JVM
- | JVMOptions
- | JVMVersion
- | JavaAppServer
- | JavaAppServerVersion
- | ManageBundler
- | MemcachedMemory
- | MysqlRootPassword
- | MysqlRootPasswordUbiquitous
- | NodejsVersion
- | PassengerVersion
- | RailsStack
- | RubyVersion
- | RubygemsVersion
- data LayerType
- = AWSFlowRuby
- | Custom
- | DBMaster
- | EcsCluster
- | JavaApp
- | LB
- | Memcached
- | MonitoringMaster
- | NodejsApp
- | PHPApp
- | RailsApp
- | Web
- data RootDeviceType
- = EBS
- | InstanceStore
- data SourceType
- data StackAttributesKeys = Color
- data VirtualizationType
- = HVM
- | Paravirtual
- data VolumeType
- data AgentVersion
- agentVersion :: AgentVersion
- avVersion :: Lens' AgentVersion (Maybe Text)
- avConfigurationManager :: Lens' AgentVersion (Maybe StackConfigurationManager)
- data App
- app :: App
- appSSLConfiguration :: Lens' App (Maybe SSLConfiguration)
- appEnvironment :: Lens' App [EnvironmentVariable]
- appEnableSSL :: Lens' App (Maybe Bool)
- appCreatedAt :: Lens' App (Maybe Text)
- appShortname :: Lens' App (Maybe Text)
- appDataSources :: Lens' App [DataSource]
- appAppSource :: Lens' App (Maybe Source)
- appAppId :: Lens' App (Maybe Text)
- appAttributes :: Lens' App (HashMap AppAttributesKeys Text)
- appName :: Lens' App (Maybe Text)
- appType :: Lens' App (Maybe AppType)
- appStackId :: Lens' App (Maybe Text)
- appDomains :: Lens' App [Text]
- appDescription :: Lens' App (Maybe Text)
- data AutoScalingThresholds
- autoScalingThresholds :: AutoScalingThresholds
- astInstanceCount :: Lens' AutoScalingThresholds (Maybe Int)
- astIgnoreMetricsTime :: Lens' AutoScalingThresholds (Maybe Natural)
- astLoadThreshold :: Lens' AutoScalingThresholds (Maybe Double)
- astThresholdsWaitTime :: Lens' AutoScalingThresholds (Maybe Natural)
- astAlarms :: Lens' AutoScalingThresholds [Text]
- astMemoryThreshold :: Lens' AutoScalingThresholds (Maybe Double)
- astCPUThreshold :: Lens' AutoScalingThresholds (Maybe Double)
- data BlockDeviceMapping
- blockDeviceMapping :: BlockDeviceMapping
- bdmVirtualName :: Lens' BlockDeviceMapping (Maybe Text)
- bdmNoDevice :: Lens' BlockDeviceMapping (Maybe Text)
- bdmEBS :: Lens' BlockDeviceMapping (Maybe EBSBlockDevice)
- bdmDeviceName :: Lens' BlockDeviceMapping (Maybe Text)
- data ChefConfiguration
- chefConfiguration :: ChefConfiguration
- ccBerkshelfVersion :: Lens' ChefConfiguration (Maybe Text)
- ccManageBerkshelf :: Lens' ChefConfiguration (Maybe Bool)
- data CloudWatchLogsConfiguration
- cloudWatchLogsConfiguration :: CloudWatchLogsConfiguration
- cwlcEnabled :: Lens' CloudWatchLogsConfiguration (Maybe Bool)
- cwlcLogStreams :: Lens' CloudWatchLogsConfiguration [CloudWatchLogsLogStream]
- data CloudWatchLogsLogStream
- cloudWatchLogsLogStream :: CloudWatchLogsLogStream
- cwllsBatchCount :: Lens' CloudWatchLogsLogStream (Maybe Int)
- cwllsFileFingerprintLines :: Lens' CloudWatchLogsLogStream (Maybe Text)
- cwllsBufferDuration :: Lens' CloudWatchLogsLogStream (Maybe Int)
- cwllsBatchSize :: Lens' CloudWatchLogsLogStream (Maybe Int)
- cwllsLogGroupName :: Lens' CloudWatchLogsLogStream (Maybe Text)
- cwllsMultiLineStartPattern :: Lens' CloudWatchLogsLogStream (Maybe Text)
- cwllsInitialPosition :: Lens' CloudWatchLogsLogStream (Maybe CloudWatchLogsInitialPosition)
- cwllsDatetimeFormat :: Lens' CloudWatchLogsLogStream (Maybe Text)
- cwllsEncoding :: Lens' CloudWatchLogsLogStream (Maybe CloudWatchLogsEncoding)
- cwllsTimeZone :: Lens' CloudWatchLogsLogStream (Maybe CloudWatchLogsTimeZone)
- cwllsFile :: Lens' CloudWatchLogsLogStream (Maybe Text)
- data Command
- command :: Command
- cDeploymentId :: Lens' Command (Maybe Text)
- cInstanceId :: Lens' Command (Maybe Text)
- cStatus :: Lens' Command (Maybe Text)
- cLogURL :: Lens' Command (Maybe Text)
- cCreatedAt :: Lens' Command (Maybe Text)
- cCommandId :: Lens' Command (Maybe Text)
- cExitCode :: Lens' Command (Maybe Int)
- cType :: Lens' Command (Maybe Text)
- cCompletedAt :: Lens' Command (Maybe Text)
- cAcknowledgedAt :: Lens' Command (Maybe Text)
- data DataSource
- dataSource :: DataSource
- dsARN :: Lens' DataSource (Maybe Text)
- dsDatabaseName :: Lens' DataSource (Maybe Text)
- dsType :: Lens' DataSource (Maybe Text)
- data Deployment
- deployment :: Deployment
- dDeploymentId :: Lens' Deployment (Maybe Text)
- dStatus :: Lens' Deployment (Maybe Text)
- dCommand :: Lens' Deployment (Maybe DeploymentCommand)
- dCreatedAt :: Lens' Deployment (Maybe Text)
- dCustomJSON :: Lens' Deployment (Maybe Text)
- dIAMUserARN :: Lens' Deployment (Maybe Text)
- dAppId :: Lens' Deployment (Maybe Text)
- dInstanceIds :: Lens' Deployment [Text]
- dCompletedAt :: Lens' Deployment (Maybe Text)
- dStackId :: Lens' Deployment (Maybe Text)
- dComment :: Lens' Deployment (Maybe Text)
- dDuration :: Lens' Deployment (Maybe Int)
- data DeploymentCommand
- deploymentCommand :: DeploymentCommandName -> DeploymentCommand
- dcArgs :: Lens' DeploymentCommand (HashMap Text [Text])
- dcName :: Lens' DeploymentCommand DeploymentCommandName
- data EBSBlockDevice
- ebsBlockDevice :: EBSBlockDevice
- ebdDeleteOnTermination :: Lens' EBSBlockDevice (Maybe Bool)
- ebdVolumeSize :: Lens' EBSBlockDevice (Maybe Int)
- ebdIOPS :: Lens' EBSBlockDevice (Maybe Int)
- ebdVolumeType :: Lens' EBSBlockDevice (Maybe VolumeType)
- ebdSnapshotId :: Lens' EBSBlockDevice (Maybe Text)
- data EcsCluster
- ecsCluster :: EcsCluster
- ecEcsClusterARN :: Lens' EcsCluster (Maybe Text)
- ecEcsClusterName :: Lens' EcsCluster (Maybe Text)
- ecRegisteredAt :: Lens' EcsCluster (Maybe Text)
- ecStackId :: Lens' EcsCluster (Maybe Text)
- data ElasticIP
- elasticIP :: ElasticIP
- eiInstanceId :: Lens' ElasticIP (Maybe Text)
- eiDomain :: Lens' ElasticIP (Maybe Text)
- eiIP :: Lens' ElasticIP (Maybe Text)
- eiName :: Lens' ElasticIP (Maybe Text)
- eiRegion :: Lens' ElasticIP (Maybe Text)
- data ElasticLoadBalancer
- elasticLoadBalancer :: ElasticLoadBalancer
- elbSubnetIds :: Lens' ElasticLoadBalancer [Text]
- elbVPCId :: Lens' ElasticLoadBalancer (Maybe Text)
- elbAvailabilityZones :: Lens' ElasticLoadBalancer [Text]
- elbRegion :: Lens' ElasticLoadBalancer (Maybe Text)
- elbElasticLoadBalancerName :: Lens' ElasticLoadBalancer (Maybe Text)
- elbStackId :: Lens' ElasticLoadBalancer (Maybe Text)
- elbEC2InstanceIds :: Lens' ElasticLoadBalancer [Text]
- elbLayerId :: Lens' ElasticLoadBalancer (Maybe Text)
- elbDNSName :: Lens' ElasticLoadBalancer (Maybe Text)
- data EnvironmentVariable
- environmentVariable :: Text -> Text -> EnvironmentVariable
- evSecure :: Lens' EnvironmentVariable (Maybe Bool)
- evKey :: Lens' EnvironmentVariable Text
- evValue :: Lens' EnvironmentVariable Text
- data Instance
- instance' :: Instance
- iPrivateDNS :: Lens' Instance (Maybe Text)
- iReportedAgentVersion :: Lens' Instance (Maybe Text)
- iInstanceId :: Lens' Instance (Maybe Text)
- iStatus :: Lens' Instance (Maybe Text)
- iPrivateIP :: Lens' Instance (Maybe Text)
- iInstallUpdatesOnBoot :: Lens' Instance (Maybe Bool)
- iVirtualizationType :: Lens' Instance (Maybe VirtualizationType)
- iInstanceProfileARN :: Lens' Instance (Maybe Text)
- iPlatform :: Lens' Instance (Maybe Text)
- iHostname :: Lens' Instance (Maybe Text)
- iSSHHostRsaKeyFingerprint :: Lens' Instance (Maybe Text)
- iSecurityGroupIds :: Lens' Instance [Text]
- iEcsClusterARN :: Lens' Instance (Maybe Text)
- iARN :: Lens' Instance (Maybe Text)
- iCreatedAt :: Lens' Instance (Maybe Text)
- iEC2InstanceId :: Lens' Instance (Maybe Text)
- iSSHKeyName :: Lens' Instance (Maybe Text)
- iAgentVersion :: Lens' Instance (Maybe Text)
- iRootDeviceVolumeId :: Lens' Instance (Maybe Text)
- iSubnetId :: Lens' Instance (Maybe Text)
- iInfrastructureClass :: Lens' Instance (Maybe Text)
- iSSHHostDsaKeyFingerprint :: Lens' Instance (Maybe Text)
- iInstanceType :: Lens' Instance (Maybe Text)
- iEBSOptimized :: Lens' Instance (Maybe Bool)
- iElasticIP :: Lens' Instance (Maybe Text)
- iOS :: Lens' Instance (Maybe Text)
- iAvailabilityZone :: Lens' Instance (Maybe Text)
- iLastServiceErrorId :: Lens' Instance (Maybe Text)
- iTenancy :: Lens' Instance (Maybe Text)
- iAutoScalingType :: Lens' Instance (Maybe AutoScalingType)
- iLayerIds :: Lens' Instance [Text]
- iArchitecture :: Lens' Instance (Maybe Architecture)
- iPublicDNS :: Lens' Instance (Maybe Text)
- iAMIId :: Lens' Instance (Maybe Text)
- iPublicIP :: Lens' Instance (Maybe Text)
- iReportedOS :: Lens' Instance (Maybe ReportedOS)
- iRegisteredBy :: Lens' Instance (Maybe Text)
- iStackId :: Lens' Instance (Maybe Text)
- iRootDeviceType :: Lens' Instance (Maybe RootDeviceType)
- iEcsContainerInstanceARN :: Lens' Instance (Maybe Text)
- iBlockDeviceMappings :: Lens' Instance [BlockDeviceMapping]
- data InstanceIdentity
- instanceIdentity :: InstanceIdentity
- iiSignature :: Lens' InstanceIdentity (Maybe Text)
- iiDocument :: Lens' InstanceIdentity (Maybe Text)
- data InstancesCount
- instancesCount :: InstancesCount
- icTerminating :: Lens' InstancesCount (Maybe Int)
- icPending :: Lens' InstancesCount (Maybe Int)
- icOnline :: Lens' InstancesCount (Maybe Int)
- icUnassigning :: Lens' InstancesCount (Maybe Int)
- icDeregistering :: Lens' InstancesCount (Maybe Int)
- icRunningSetup :: Lens' InstancesCount (Maybe Int)
- icRequested :: Lens' InstancesCount (Maybe Int)
- icStopFailed :: Lens' InstancesCount (Maybe Int)
- icBooting :: Lens' InstancesCount (Maybe Int)
- icStopped :: Lens' InstancesCount (Maybe Int)
- icRebooting :: Lens' InstancesCount (Maybe Int)
- icAssigning :: Lens' InstancesCount (Maybe Int)
- icShuttingDown :: Lens' InstancesCount (Maybe Int)
- icSetupFailed :: Lens' InstancesCount (Maybe Int)
- icConnectionLost :: Lens' InstancesCount (Maybe Int)
- icTerminated :: Lens' InstancesCount (Maybe Int)
- icStopping :: Lens' InstancesCount (Maybe Int)
- icRegistered :: Lens' InstancesCount (Maybe Int)
- icStartFailed :: Lens' InstancesCount (Maybe Int)
- icRegistering :: Lens' InstancesCount (Maybe Int)
- data Layer
- layer :: Layer
- lCustomInstanceProfileARN :: Lens' Layer (Maybe Text)
- lCustomSecurityGroupIds :: Lens' Layer [Text]
- lInstallUpdatesOnBoot :: Lens' Layer (Maybe Bool)
- lCloudWatchLogsConfiguration :: Lens' Layer (Maybe CloudWatchLogsConfiguration)
- lLifecycleEventConfiguration :: Lens' Layer (Maybe LifecycleEventConfiguration)
- lARN :: Lens' Layer (Maybe Text)
- lCreatedAt :: Lens' Layer (Maybe Text)
- lShortname :: Lens' Layer (Maybe Text)
- lDefaultRecipes :: Lens' Layer (Maybe Recipes)
- lCustomRecipes :: Lens' Layer (Maybe Recipes)
- lCustomJSON :: Lens' Layer (Maybe Text)
- lVolumeConfigurations :: Lens' Layer [VolumeConfiguration]
- lEnableAutoHealing :: Lens' Layer (Maybe Bool)
- lPackages :: Lens' Layer [Text]
- lAttributes :: Lens' Layer (HashMap LayerAttributesKeys (Maybe Text))
- lName :: Lens' Layer (Maybe Text)
- lAutoAssignPublicIPs :: Lens' Layer (Maybe Bool)
- lType :: Lens' Layer (Maybe LayerType)
- lUseEBSOptimizedInstances :: Lens' Layer (Maybe Bool)
- lStackId :: Lens' Layer (Maybe Text)
- lLayerId :: Lens' Layer (Maybe Text)
- lDefaultSecurityGroupNames :: Lens' Layer [Text]
- lAutoAssignElasticIPs :: Lens' Layer (Maybe Bool)
- data LifecycleEventConfiguration
- lifecycleEventConfiguration :: LifecycleEventConfiguration
- lecShutdown :: Lens' LifecycleEventConfiguration (Maybe ShutdownEventConfiguration)
- data LoadBasedAutoScalingConfiguration
- loadBasedAutoScalingConfiguration :: LoadBasedAutoScalingConfiguration
- lbascUpScaling :: Lens' LoadBasedAutoScalingConfiguration (Maybe AutoScalingThresholds)
- lbascEnable :: Lens' LoadBasedAutoScalingConfiguration (Maybe Bool)
- lbascDownScaling :: Lens' LoadBasedAutoScalingConfiguration (Maybe AutoScalingThresholds)
- lbascLayerId :: Lens' LoadBasedAutoScalingConfiguration (Maybe Text)
- data OperatingSystem
- operatingSystem :: OperatingSystem
- osReportedVersion :: Lens' OperatingSystem (Maybe Text)
- osSupported :: Lens' OperatingSystem (Maybe Bool)
- osName :: Lens' OperatingSystem (Maybe Text)
- osId :: Lens' OperatingSystem (Maybe Text)
- osConfigurationManagers :: Lens' OperatingSystem [OperatingSystemConfigurationManager]
- osType :: Lens' OperatingSystem (Maybe Text)
- osReportedName :: Lens' OperatingSystem (Maybe Text)
- data OperatingSystemConfigurationManager
- operatingSystemConfigurationManager :: OperatingSystemConfigurationManager
- oscmName :: Lens' OperatingSystemConfigurationManager (Maybe Text)
- oscmVersion :: Lens' OperatingSystemConfigurationManager (Maybe Text)
- data Permission
- permission :: Permission
- pIAMUserARN :: Lens' Permission (Maybe Text)
- pAllowSudo :: Lens' Permission (Maybe Bool)
- pStackId :: Lens' Permission (Maybe Text)
- pLevel :: Lens' Permission (Maybe Text)
- pAllowSSH :: Lens' Permission (Maybe Bool)
- data RAIdArray
- rAIdArray :: RAIdArray
- raiaInstanceId :: Lens' RAIdArray (Maybe Text)
- raiaSize :: Lens' RAIdArray (Maybe Int)
- raiaIOPS :: Lens' RAIdArray (Maybe Int)
- raiaCreatedAt :: Lens' RAIdArray (Maybe Text)
- raiaRAIdLevel :: Lens' RAIdArray (Maybe Int)
- raiaDevice :: Lens' RAIdArray (Maybe Text)
- raiaNumberOfDisks :: Lens' RAIdArray (Maybe Int)
- raiaAvailabilityZone :: Lens' RAIdArray (Maybe Text)
- raiaName :: Lens' RAIdArray (Maybe Text)
- raiaRAIdArrayId :: Lens' RAIdArray (Maybe Text)
- raiaVolumeType :: Lens' RAIdArray (Maybe Text)
- raiaStackId :: Lens' RAIdArray (Maybe Text)
- raiaMountPoint :: Lens' RAIdArray (Maybe Text)
- data RDSDBInstance
- rdsDBInstance :: RDSDBInstance
- rdiRDSDBInstanceARN :: Lens' RDSDBInstance (Maybe Text)
- rdiDBUser :: Lens' RDSDBInstance (Maybe Text)
- rdiMissingOnRDS :: Lens' RDSDBInstance (Maybe Bool)
- rdiEngine :: Lens' RDSDBInstance (Maybe Text)
- rdiAddress :: Lens' RDSDBInstance (Maybe Text)
- rdiDBInstanceIdentifier :: Lens' RDSDBInstance (Maybe Text)
- rdiRegion :: Lens' RDSDBInstance (Maybe Text)
- rdiStackId :: Lens' RDSDBInstance (Maybe Text)
- rdiDBPassword :: Lens' RDSDBInstance (Maybe Text)
- data Recipes
- recipes :: Recipes
- rSetup :: Lens' Recipes [Text]
- rShutdown :: Lens' Recipes [Text]
- rUndeploy :: Lens' Recipes [Text]
- rConfigure :: Lens' Recipes [Text]
- rDeploy :: Lens' Recipes [Text]
- data ReportedOS
- reportedOS :: ReportedOS
- roFamily :: Lens' ReportedOS (Maybe Text)
- roName :: Lens' ReportedOS (Maybe Text)
- roVersion :: Lens' ReportedOS (Maybe Text)
- data SSLConfiguration
- sslConfiguration :: SSLConfiguration
- scPrivateKey :: Lens' SSLConfiguration (Maybe Text)
- scCertificate :: Lens' SSLConfiguration (Maybe Text)
- scChain :: Lens' SSLConfiguration (Maybe Text)
- data SelfUserProfile
- selfUserProfile :: SelfUserProfile
- supSSHPublicKey :: Lens' SelfUserProfile (Maybe Text)
- supSSHUsername :: Lens' SelfUserProfile (Maybe Text)
- supIAMUserARN :: Lens' SelfUserProfile (Maybe Text)
- supName :: Lens' SelfUserProfile (Maybe Text)
- data ServiceError'
- serviceError' :: ServiceError'
- seInstanceId :: Lens' ServiceError' (Maybe Text)
- seCreatedAt :: Lens' ServiceError' (Maybe Text)
- seServiceErrorId :: Lens' ServiceError' (Maybe Text)
- seType :: Lens' ServiceError' (Maybe Text)
- seStackId :: Lens' ServiceError' (Maybe Text)
- seMessage :: Lens' ServiceError' (Maybe Text)
- data ShutdownEventConfiguration
- shutdownEventConfiguration :: ShutdownEventConfiguration
- secExecutionTimeout :: Lens' ShutdownEventConfiguration (Maybe Int)
- secDelayUntilElbConnectionsDrained :: Lens' ShutdownEventConfiguration (Maybe Bool)
- data Source
- source :: Source
- sURL :: Lens' Source (Maybe Text)
- sUsername :: Lens' Source (Maybe Text)
- sSSHKey :: Lens' Source (Maybe Text)
- sPassword :: Lens' Source (Maybe Text)
- sType :: Lens' Source (Maybe SourceType)
- sRevision :: Lens' Source (Maybe Text)
- data Stack
- stack :: Stack
- sDefaultInstanceProfileARN :: Lens' Stack (Maybe Text)
- sServiceRoleARN :: Lens' Stack (Maybe Text)
- sDefaultRootDeviceType :: Lens' Stack (Maybe RootDeviceType)
- sARN :: Lens' Stack (Maybe Text)
- sCreatedAt :: Lens' Stack (Maybe Text)
- sVPCId :: Lens' Stack (Maybe Text)
- sChefConfiguration :: Lens' Stack (Maybe ChefConfiguration)
- sAgentVersion :: Lens' Stack (Maybe Text)
- sDefaultSSHKeyName :: Lens' Stack (Maybe Text)
- sCustomJSON :: Lens' Stack (Maybe Text)
- sCustomCookbooksSource :: Lens' Stack (Maybe Source)
- sDefaultAvailabilityZone :: Lens' Stack (Maybe Text)
- sAttributes :: Lens' Stack (HashMap StackAttributesKeys (Maybe Text))
- sName :: Lens' Stack (Maybe Text)
- sDefaultOS :: Lens' Stack (Maybe Text)
- sUseOpsworksSecurityGroups :: Lens' Stack (Maybe Bool)
- sUseCustomCookbooks :: Lens' Stack (Maybe Bool)
- sDefaultSubnetId :: Lens' Stack (Maybe Text)
- sRegion :: Lens' Stack (Maybe Text)
- sConfigurationManager :: Lens' Stack (Maybe StackConfigurationManager)
- sStackId :: Lens' Stack (Maybe Text)
- sHostnameTheme :: Lens' Stack (Maybe Text)
- data StackConfigurationManager
- stackConfigurationManager :: StackConfigurationManager
- scmName :: Lens' StackConfigurationManager (Maybe Text)
- scmVersion :: Lens' StackConfigurationManager (Maybe Text)
- data StackSummary
- stackSummary :: StackSummary
- ssARN :: Lens' StackSummary (Maybe Text)
- ssAppsCount :: Lens' StackSummary (Maybe Int)
- ssName :: Lens' StackSummary (Maybe Text)
- ssStackId :: Lens' StackSummary (Maybe Text)
- ssLayersCount :: Lens' StackSummary (Maybe Int)
- ssInstancesCount :: Lens' StackSummary (Maybe InstancesCount)
- data TemporaryCredential
- temporaryCredential :: TemporaryCredential
- tcInstanceId :: Lens' TemporaryCredential (Maybe Text)
- tcUsername :: Lens' TemporaryCredential (Maybe Text)
- tcPassword :: Lens' TemporaryCredential (Maybe Text)
- tcValidForInMinutes :: Lens' TemporaryCredential (Maybe Int)
- data TimeBasedAutoScalingConfiguration
- timeBasedAutoScalingConfiguration :: TimeBasedAutoScalingConfiguration
- tbascInstanceId :: Lens' TimeBasedAutoScalingConfiguration (Maybe Text)
- tbascAutoScalingSchedule :: Lens' TimeBasedAutoScalingConfiguration (Maybe WeeklyAutoScalingSchedule)
- data UserProfile
- userProfile :: UserProfile
- upAllowSelfManagement :: Lens' UserProfile (Maybe Bool)
- upSSHPublicKey :: Lens' UserProfile (Maybe Text)
- upSSHUsername :: Lens' UserProfile (Maybe Text)
- upIAMUserARN :: Lens' UserProfile (Maybe Text)
- upName :: Lens' UserProfile (Maybe Text)
- data Volume
- volume :: Volume
- vInstanceId :: Lens' Volume (Maybe Text)
- vStatus :: Lens' Volume (Maybe Text)
- vSize :: Lens' Volume (Maybe Int)
- vIOPS :: Lens' Volume (Maybe Int)
- vDevice :: Lens' Volume (Maybe Text)
- vEncrypted :: Lens' Volume (Maybe Bool)
- vAvailabilityZone :: Lens' Volume (Maybe Text)
- vName :: Lens' Volume (Maybe Text)
- vRAIdArrayId :: Lens' Volume (Maybe Text)
- vVolumeId :: Lens' Volume (Maybe Text)
- vRegion :: Lens' Volume (Maybe Text)
- vVolumeType :: Lens' Volume (Maybe Text)
- vEC2VolumeId :: Lens' Volume (Maybe Text)
- vMountPoint :: Lens' Volume (Maybe Text)
- data VolumeConfiguration
- volumeConfiguration :: Text -> Int -> Int -> VolumeConfiguration
- vcIOPS :: Lens' VolumeConfiguration (Maybe Int)
- vcRAIdLevel :: Lens' VolumeConfiguration (Maybe Int)
- vcEncrypted :: Lens' VolumeConfiguration (Maybe Bool)
- vcVolumeType :: Lens' VolumeConfiguration (Maybe Text)
- vcMountPoint :: Lens' VolumeConfiguration Text
- vcNumberOfDisks :: Lens' VolumeConfiguration Int
- vcSize :: Lens' VolumeConfiguration Int
- data WeeklyAutoScalingSchedule
- weeklyAutoScalingSchedule :: WeeklyAutoScalingSchedule
- wassThursday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text)
- wassWednesday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text)
- wassSaturday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text)
- wassMonday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text)
- wassFriday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text)
- wassSunday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text)
- wassTuesday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text)
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by OpsWorks.
ValidationException
_ValidationException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a request was not valid.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
Indicates that a resource was not found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
InstanceTerminated
instanceTerminated :: Wait DescribeInstances Source #
Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
DeploymentSuccessful
deploymentSuccessful :: Wait DescribeDeployments Source #
Polls DescribeDeployments every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
InstanceStopped
instanceStopped :: Wait DescribeInstances Source #
Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
InstanceOnline
instanceOnline :: Wait DescribeInstances Source #
Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
AppExists
appExists :: Wait DescribeApps Source #
Polls DescribeApps every 1 seconds until a successful state is reached. An error is returned after 40 failed checks.
InstanceRegistered
instanceRegistered :: Wait DescribeInstances Source #
Polls DescribeInstances every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
DescribeRDSDBInstances
DeleteStack
UpdateStack
CreateLayer
SetLoadBasedAutoScaling
DeregisterRDSDBInstance
UnassignVolume
CreateInstance
DescribeLayers
RegisterElasticIP
DescribeAgentVersions
CreateDeployment
AssignInstance
DescribeStacks
DeleteInstance
UpdateInstance
DeregisterVolume
RebootInstance
DeleteApp
UpdateApp
UpdateRDSDBInstance
DescribeTimeBasedAutoScaling
StopStack
DescribeVolumes
DisassociateElasticIP
RegisterEcsCluster
StopInstance
RegisterVolume
SetTimeBasedAutoScaling
DescribeUserProfiles
AttachElasticLoadBalancer
DeregisterElasticIP
DeregisterEcsCluster
DescribeApps
UpdateMyUserProfile
DescribeStackSummary
DescribeInstances
DescribeDeployments
DescribeElasticIPs
GrantAccess
DeleteLayer
UpdateLayer
CreateStack
UpdateElasticIP
CreateApp
GetHostnameSuggestion
CloneStack
DescribePermissions
DetachElasticLoadBalancer
RegisterInstance
AssociateElasticIP
DescribeLoadBasedAutoScaling
DescribeStackProvisioningParameters
TagResource
ListTags
UnassignInstance
DescribeMyUserProfile
DeleteUserProfile
UpdateUserProfile
DescribeServiceErrors
RegisterRDSDBInstance
UntagResource
StartStack
CreateUserProfile
DescribeOperatingSystems
DescribeCommands
AssignVolume
DescribeElasticLoadBalancers
SetPermission
DeregisterInstance
DescribeEcsClusters (Paginated)
DescribeRAIdArrays
UpdateVolume
StartInstance
Types
AppAttributesKeys
data AppAttributesKeys Source #
Constructors
| AWSFlowRubySettings | |
| AutoBundleOnDeploy | |
| DocumentRoot | |
| RailsEnv |
Instances
AppType
Instances
Architecture
data Architecture Source #
Instances
AutoScalingType
data AutoScalingType Source #
Instances
CloudWatchLogsEncoding
data 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.
Constructors
Instances
CloudWatchLogsInitialPosition
data CloudWatchLogsInitialPosition Source #
Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. It's only used if there is no state persisted for that log stream.
Constructors
| EndOfFile | |
| StartOfFile |
Instances
CloudWatchLogsTimeZone
data CloudWatchLogsTimeZone Source #
The preferred time zone for logs streamed to CloudWatch Logs. Valid values are LOCAL and UTC , for Coordinated Universal Time.
Instances
DeploymentCommandName
data DeploymentCommandName Source #
Constructors
| Configure | |
| Deploy | |
| ExecuteRecipes | |
| InstallDependencies | |
| Restart | |
| Rollback | |
| Setup | |
| Start | |
| Stop | |
| Undeploy | |
| UpdateCustomCookbooks | |
| UpdateDependencies |
Instances
LayerAttributesKeys
data LayerAttributesKeys Source #
Constructors
Instances
LayerType
Constructors
| AWSFlowRuby | |
| Custom | |
| DBMaster | |
| EcsCluster | |
| JavaApp | |
| LB | |
| Memcached | |
| MonitoringMaster | |
| NodejsApp | |
| PHPApp | |
| RailsApp | |
| Web |
Instances
RootDeviceType
data RootDeviceType Source #
Constructors
| EBS | |
| InstanceStore |
Instances
SourceType
data SourceType Source #
Instances
StackAttributesKeys
data StackAttributesKeys Source #
Constructors
| Color |
Instances
VirtualizationType
data VirtualizationType Source #
Constructors
| HVM | |
| Paravirtual |
Instances
VolumeType
data VolumeType Source #
Instances
AgentVersion
data AgentVersion Source #
Describes an agent version.
See: agentVersion smart constructor.
Instances
agentVersion :: AgentVersion Source #
Creates a value of AgentVersion with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
avVersion- The agent version.avConfigurationManager- The configuration manager.
avConfigurationManager :: Lens' AgentVersion (Maybe StackConfigurationManager) Source #
The configuration manager.
App
A description of the app.
See: app smart constructor.
Instances
Creates a value of App with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
appSSLConfiguration- AnSslConfigurationobject with the SSL configuration.appEnvironment- An array ofEnvironmentVariableobjects 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 .appEnableSSL- Whether to enable SSL for the app.appCreatedAt- When the app was created.appShortname- The app's short name.appDataSources- The app's data sources.appAppSource- ASourceobject that describes the app repository.appAppId- The app ID.appAttributes- The stack attributes.appName- The app name.appType- The app type.appStackId- The app stack ID.appDomains- The app vhost settings with multiple domains separated by commas. For example:'www.example.com, example.com'appDescription- A description of the app.
appSSLConfiguration :: Lens' App (Maybe SSLConfiguration) Source #
An SslConfiguration object with the SSL configuration.
appEnvironment :: Lens' App [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 .
appDataSources :: Lens' App [DataSource] Source #
The app's data sources.
appAttributes :: Lens' App (HashMap AppAttributesKeys Text) Source #
The stack attributes.
appDomains :: Lens' App [Text] Source #
The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'
AutoScalingThresholds
data AutoScalingThresholds Source #
Describes a load-based auto scaling upscaling or downscaling threshold configuration, which specifies when AWS OpsWorks Stacks starts or stops load-based instances.
See: autoScalingThresholds smart constructor.
Instances
autoScalingThresholds :: AutoScalingThresholds Source #
Creates a value of AutoScalingThresholds with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
astInstanceCount- The number of instances to add or remove when the load exceeds a threshold.astIgnoreMetricsTime- 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.IgnoreMetricsTimeallows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.astLoadThreshold- The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing) .astThresholdsWaitTime- The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.astAlarms- 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.astMemoryThreshold- The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.astCPUThreshold- The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
astInstanceCount :: Lens' AutoScalingThresholds (Maybe Int) Source #
The number of instances to add or remove when the load exceeds a threshold.
astIgnoreMetricsTime :: 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.
astLoadThreshold :: 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) .
astThresholdsWaitTime :: 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.
astAlarms :: Lens' AutoScalingThresholds [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.
astMemoryThreshold :: Lens' AutoScalingThresholds (Maybe Double) Source #
The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
astCPUThreshold :: Lens' AutoScalingThresholds (Maybe Double) Source #
The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
BlockDeviceMapping
data BlockDeviceMapping Source #
Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.
See: blockDeviceMapping smart constructor.
Instances
blockDeviceMapping :: BlockDeviceMapping Source #
Creates a value of BlockDeviceMapping with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bdmVirtualName- The virtual device name. For more information, see BlockDeviceMapping .bdmNoDevice- Suppresses the specified device included in the AMI's block device mapping.bdmEBS- AnEBSBlockDevicethat defines how to configure an Amazon EBS volume when the instance is launched.bdmDeviceName- The device name that is exposed to the instance, such asdevsdh. For the root device, you can use the explicit device name or you can set this parameter toROOT_DEVICEand AWS OpsWorks Stacks will provide the correct device name.
bdmVirtualName :: Lens' BlockDeviceMapping (Maybe Text) Source #
The virtual device name. For more information, see BlockDeviceMapping .
bdmNoDevice :: Lens' BlockDeviceMapping (Maybe Text) Source #
Suppresses the specified device included in the AMI's block device mapping.
bdmEBS :: Lens' BlockDeviceMapping (Maybe EBSBlockDevice) Source #
An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.
bdmDeviceName :: Lens' BlockDeviceMapping (Maybe Text) Source #
The device name that is exposed to the instance, such as devsdh . 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
data ChefConfiguration Source #
Describes the Chef configuration.
See: chefConfiguration smart constructor.
Instances
chefConfiguration :: ChefConfiguration Source #
Creates a value of ChefConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ccBerkshelfVersion- The Berkshelf version.ccManageBerkshelf- Whether to enable Berkshelf.
ccBerkshelfVersion :: Lens' ChefConfiguration (Maybe Text) Source #
The Berkshelf version.
ccManageBerkshelf :: Lens' ChefConfiguration (Maybe Bool) Source #
Whether to enable Berkshelf.
CloudWatchLogsConfiguration
data CloudWatchLogsConfiguration Source #
Describes the Amazon CloudWatch logs configuration for a layer.
See: cloudWatchLogsConfiguration smart constructor.
Instances
cloudWatchLogsConfiguration :: CloudWatchLogsConfiguration Source #
Creates a value of CloudWatchLogsConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwlcEnabled- Whether CloudWatch Logs is enabled for a layer.cwlcLogStreams- A list of configuration options for CloudWatch Logs.
cwlcEnabled :: Lens' CloudWatchLogsConfiguration (Maybe Bool) Source #
Whether CloudWatch Logs is enabled for a layer.
cwlcLogStreams :: Lens' CloudWatchLogsConfiguration [CloudWatchLogsLogStream] Source #
A list of configuration options for CloudWatch Logs.
CloudWatchLogsLogStream
data CloudWatchLogsLogStream Source #
Describes the Amazon CloudWatch logs configuration for a layer. For detailed information about members of this data type, see the CloudWatch Logs Agent Reference .
See: cloudWatchLogsLogStream smart constructor.
Instances
cloudWatchLogsLogStream :: CloudWatchLogsLogStream Source #
Creates a value of CloudWatchLogsLogStream with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cwllsBatchCount- Specifies the max number of log events in a batch, up to 10000. The default value is 1000.cwllsFileFingerprintLines- 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.cwllsBufferDuration- Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.cwllsBatchSize- 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.cwllsLogGroupName- 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).cwllsMultiLineStartPattern- Specifies the pattern for identifying the start of a log message.cwllsInitialPosition- 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.cwllsDatetimeFormat- Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference .cwllsEncoding- Specifies the encoding of the log file so that the file can be read correctly. The default isutf_8. Encodings supported by Pythoncodecs.decode()can be used here.cwllsTimeZone- Specifies the time zone of log event time stamps.cwllsFile- Specifies log files that you want to push to CloudWatch Logs.Filecan point to a specific file or multiple files (by using wild card characters such asvarlog/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 asaccess_log.2014-06-01-01,access_log.2014-06-01-02, and so on by using a pattern likeaccess_log.*. Don't use a wildcard to match multiple file types, such asaccess_log_80andaccess_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.
cwllsBatchCount :: Lens' CloudWatchLogsLogStream (Maybe Int) Source #
Specifies the max number of log events in a batch, up to 10000. The default value is 1000.
cwllsFileFingerprintLines :: 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.
cwllsBufferDuration :: 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.
cwllsBatchSize :: 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.
cwllsMultiLineStartPattern :: Lens' CloudWatchLogsLogStream (Maybe Text) Source #
Specifies the pattern for identifying the start of a log message.
cwllsInitialPosition :: 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.
cwllsDatetimeFormat :: Lens' CloudWatchLogsLogStream (Maybe Text) Source #
Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference .
cwllsEncoding :: 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.
cwllsTimeZone :: Lens' CloudWatchLogsLogStream (Maybe CloudWatchLogsTimeZone) Source #
Specifies the time zone of log event time stamps.
cwllsFile :: 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 varlog/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
Describes a command.
See: command smart constructor.
Instances
Creates a value of Command with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cDeploymentId- The command deployment ID.cInstanceId- The ID of the instance where the command was executed.cStatus- The command status: * failed * successful * skipped * pendingcLogURL- The URL of the command log.cCreatedAt- Date and time when the command was run.cCommandId- The command ID.cExitCode- The command exit code.cType- The command type: *configure*deploy*execute_recipes*install_dependencies*restart*rollback*setup*start*stop*undeploy*update_custom_cookbooks*update_dependenciescCompletedAt- Date when the command completed.cAcknowledgedAt- Date and time when the command was acknowledged.
cInstanceId :: Lens' Command (Maybe Text) Source #
The ID of the instance where the command was executed.
cStatus :: Lens' Command (Maybe Text) Source #
The command status: * failed * successful * skipped * pending
cType :: 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
cAcknowledgedAt :: Lens' Command (Maybe Text) Source #
Date and time when the command was acknowledged.
DataSource
data DataSource Source #
Describes an app's data source.
See: dataSource smart constructor.
Instances
dataSource :: DataSource Source #
Creates a value of DataSource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dsARN- The data source's ARN.dsDatabaseName- The database name.dsType- The data source's type,AutoSelectOpsworksMysqlInstance,OpsworksMysqlInstance,RdsDbInstance, orNone.
dsDatabaseName :: Lens' DataSource (Maybe Text) Source #
The database name.
dsType :: Lens' DataSource (Maybe Text) Source #
The data source's type, AutoSelectOpsworksMysqlInstance , OpsworksMysqlInstance , RdsDbInstance , or None .
Deployment
data Deployment Source #
Describes a deployment of a stack or app.
See: deployment smart constructor.
Instances
deployment :: Deployment Source #
Creates a value of Deployment with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dDeploymentId- The deployment ID.dStatus- The deployment status: * running * successful * faileddCommand- Undocumented member.dCreatedAt- Date when the deployment was created.dCustomJSON- 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 .dIAMUserARN- The user's IAM ARN.dAppId- The app ID.dInstanceIds- The IDs of the target instances.dCompletedAt- Date when the deployment completed.dStackId- The stack ID.dComment- A user-defined comment.dDuration- The deployment duration.
dDeploymentId :: Lens' Deployment (Maybe Text) Source #
The deployment ID.
dStatus :: Lens' Deployment (Maybe Text) Source #
The deployment status: * running * successful * failed
dCommand :: Lens' Deployment (Maybe DeploymentCommand) Source #
Undocumented member.
dCreatedAt :: Lens' Deployment (Maybe Text) Source #
Date when the deployment was created.
dCustomJSON :: 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 .
dIAMUserARN :: Lens' Deployment (Maybe Text) Source #
The user's IAM ARN.
dInstanceIds :: Lens' Deployment [Text] Source #
The IDs of the target instances.
dCompletedAt :: Lens' Deployment (Maybe Text) Source #
Date when the deployment completed.
DeploymentCommand
data DeploymentCommand Source #
Used to specify a stack or deployment command.
See: deploymentCommand smart constructor.
Instances
Arguments
| :: DeploymentCommandName | |
| -> DeploymentCommand |
Creates a value of DeploymentCommand with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
dcArgs- 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", ...], ...}Theupdate_dependenciescommand takes two arguments: *upgrade_os_to- Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such asAmazon Linux 2016.09. You must also set theallow_rebootargument 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 eithertrueorfalse. The default value isfalse. For example, to upgrade an instance to Amazon Linux 2016.09, setArgsto the following.{ "upgrade_os_to":["Amazon Linux 2016.09"], "allow_reboot":["true"] }dcName- 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 anArgsparameter namedrecipesto the list of recipes to be executed. For example, to executephpapp::appsetup, setArgsto{"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. For apps, the following commands are available: *deploy: Deploy an app. Ruby on Rails apps have an optionalArgsparameter namedmigrate. SetArgsto {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}. *rollbackRoll 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.
dcArgs :: Lens' DeploymentCommand (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"] }
dcName :: 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. 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
data EBSBlockDevice Source #
Describes an Amazon EBS volume. This data type maps directly to the Amazon EC2 EbsBlockDevice data type.
See: ebsBlockDevice smart constructor.
Instances
ebsBlockDevice :: EBSBlockDevice Source #
Creates a value of EBSBlockDevice with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ebdDeleteOnTermination- Whether the volume is deleted on instance termination.ebdVolumeSize- The volume size, in GiB. For more information, see EbsBlockDevice .ebdIOPS- The number of IO operations per second (IOPS) that the volume supports. For more information, see <http:docs.aws.amazon.comAWSEC2latestAPIReference/API_EbsBlockDevice.html EbsBlockDevice> .ebdVolumeType- The volume type.gp2for General Purpose (SSD) volumes,io1for Provisioned IOPS (SSD) volumes,st1for Throughput Optimized hard disk drives (HDD),sc1for Cold HDD,andstandardfor Magnetic volumes. If you specify theio1volume type, you must also specify a value for theIopsattribute. 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).ebdSnapshotId- The snapshot ID.
ebdDeleteOnTermination :: Lens' EBSBlockDevice (Maybe Bool) Source #
Whether the volume is deleted on instance termination.
ebdVolumeSize :: Lens' EBSBlockDevice (Maybe Int) Source #
The volume size, in GiB. For more information, see EbsBlockDevice .
ebdIOPS :: Lens' EBSBlockDevice (Maybe Int) Source #
The number of IO operations per second (IOPS) that the volume supports. For more information, see <http:docs.aws.amazon.comAWSEC2latestAPIReference/API_EbsBlockDevice.html EbsBlockDevice> .
ebdVolumeType :: 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).
ebdSnapshotId :: Lens' EBSBlockDevice (Maybe Text) Source #
The snapshot ID.
EcsCluster
data EcsCluster Source #
Describes a registered Amazon ECS cluster.
See: ecsCluster smart constructor.
Instances
ecsCluster :: EcsCluster Source #
Creates a value of EcsCluster with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ecEcsClusterARN- The cluster's ARN.ecEcsClusterName- The cluster name.ecRegisteredAt- The time and date that the cluster was registered with the stack.ecStackId- The stack ID.
ecEcsClusterARN :: Lens' EcsCluster (Maybe Text) Source #
The cluster's ARN.
ecEcsClusterName :: Lens' EcsCluster (Maybe Text) Source #
The cluster name.
ecRegisteredAt :: Lens' EcsCluster (Maybe Text) Source #
The time and date that the cluster was registered with the stack.
ElasticIP
Describes an Elastic IP address.
See: elasticIP smart constructor.
Instances
elasticIP :: ElasticIP Source #
Creates a value of ElasticIP with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eiInstanceId- The ID of the instance that the address is attached to.eiDomain- The domain.eiIP- The IP address.eiName- The name.eiRegion- The AWS region. For more information, see Regions and Endpoints .
eiInstanceId :: Lens' ElasticIP (Maybe Text) Source #
The ID of the instance that the address is attached to.
eiRegion :: Lens' ElasticIP (Maybe Text) Source #
The AWS region. For more information, see Regions and Endpoints .
ElasticLoadBalancer
data ElasticLoadBalancer Source #
Describes an Elastic Load Balancing instance.
See: elasticLoadBalancer smart constructor.
Instances
elasticLoadBalancer :: ElasticLoadBalancer Source #
Creates a value of ElasticLoadBalancer with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
elbSubnetIds- A list of subnet IDs, if the stack is running in a VPC.elbVPCId- The VPC ID.elbAvailabilityZones- A list of Availability Zones.elbRegion- The instance's AWS region.elbElasticLoadBalancerName- The Elastic Load Balancing instance's name.elbStackId- The ID of the stack that the instance is associated with.elbEC2InstanceIds- A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.elbLayerId- The ID of the layer that the instance is attached to.elbDNSName- The instance's public DNS name.
elbSubnetIds :: Lens' ElasticLoadBalancer [Text] Source #
A list of subnet IDs, if the stack is running in a VPC.
elbAvailabilityZones :: Lens' ElasticLoadBalancer [Text] Source #
A list of Availability Zones.
elbElasticLoadBalancerName :: Lens' ElasticLoadBalancer (Maybe Text) Source #
The Elastic Load Balancing instance's name.
elbStackId :: Lens' ElasticLoadBalancer (Maybe Text) Source #
The ID of the stack that the instance is associated with.
elbEC2InstanceIds :: Lens' ElasticLoadBalancer [Text] Source #
A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
elbLayerId :: Lens' ElasticLoadBalancer (Maybe Text) Source #
The ID of the layer that the instance is attached to.
elbDNSName :: Lens' ElasticLoadBalancer (Maybe Text) Source #
The instance's public DNS name.
EnvironmentVariable
data EnvironmentVariable Source #
Represents an app's environment variable.
See: environmentVariable smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> EnvironmentVariable |
Creates a value of EnvironmentVariable with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
evSecure- (Optional) Whether the variable's value will be returned by theDescribeAppsaction. To conceal an environment variable's value, setSecuretotrue.DescribeAppsthen returns*****FILTERED*****instead of the actual value. The default value forSecureisfalse.evKey- (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.evValue- (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.
evSecure :: 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 .
evKey :: 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.
evValue :: 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
Describes an instance.
See: instance' smart constructor.
Instances
instance' :: Instance Source #
Creates a value of Instance with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iPrivateDNS- The instance's private DNS name.iReportedAgentVersion- The instance's reported AWS OpsWorks Stacks agent version.iInstanceId- The instance ID.iStatus- The instance status: *booting*connection_lost*online*pending*rebooting*requested*running_setup*setup_failed*shutting_down*start_failed*stop_failed*stopped*stopping*terminated*terminatingiPrivateIP- The instance's private IP address.iInstallUpdatesOnBoot- Whether to install operating system and package updates when the instance boots. The default value istrue. If this value is set tofalse, you must then update your instances manually by usingCreateDeploymentto run theupdate_dependenciesstack command or by manually runningyum(Amazon Linux) orapt-get(Ubuntu) on the instances.iVirtualizationType- The instance's virtualization type:paravirtualorhvm.iInstanceProfileARN- The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers .iPlatform- The instance's platform.iHostname- The instance host name.iSSHHostRsaKeyFingerprint- The SSH key's RSA fingerprint.iSecurityGroupIds- An array containing the instance security group IDs.iEcsClusterARN- For container instances, the Amazon ECS cluster's ARN.iARN- Undocumented member.iCreatedAt- The time that the instance was created.iEC2InstanceId- The ID of the associated Amazon EC2 instance.iSSHKeyName- The instance's Amazon EC2 key-pair name.iAgentVersion- The agent version. This parameter is set toINHERITif the instance inherits the default stack setting or to a a version number for a fixed agent version.iRootDeviceVolumeId- The root device volume ID.iSubnetId- The instance's subnet ID; applicable only if the stack is running in a VPC.iInfrastructureClass- For registered instances, the infrastructure class:ec2oron-premises.iSSHHostDsaKeyFingerprint- The SSH key's Deep Security Agent (DSA) fingerprint.iInstanceType- The instance type, such ast2.micro.iEBSOptimized- Whether this is an Amazon EBS-optimized instance.iElasticIP- The instance Elastic IP address .iOS- The instance's operating system.iAvailabilityZone- The instance Availability Zone. For more information, see Regions and Endpoints .iLastServiceErrorId- The ID of the last service error. For more information, callDescribeServiceErrors.iTenancy- The instance's tenancy option, such asdedicatedorhost.iAutoScalingType- For load-based or time-based instances, the type.iLayerIds- An array containing the instance layer IDs.iArchitecture- The instance architecture: "i386" or "x86_64".iPublicDNS- The instance public DNS name.iAMIId- A custom AMI ID to be used to create the instance. For more information, see InstancesiPublicIP- The instance public IP address.iReportedOS- For registered instances, the reported operating system.iRegisteredBy- For registered instances, who performed the registration.iStackId- The stack ID.iRootDeviceType- The instance's root device type. For more information, see Storage for the Root Device .iEcsContainerInstanceARN- For container instances, the instance's ARN.iBlockDeviceMappings- An array ofBlockDeviceMappingobjects that specify the instance's block device mappings.
iReportedAgentVersion :: Lens' Instance (Maybe Text) Source #
The instance's reported AWS OpsWorks Stacks agent version.
iStatus :: 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
iInstallUpdatesOnBoot :: 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.
iVirtualizationType :: Lens' Instance (Maybe VirtualizationType) Source #
The instance's virtualization type: paravirtual or hvm .
iInstanceProfileARN :: Lens' Instance (Maybe Text) Source #
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers .
iSecurityGroupIds :: Lens' Instance [Text] Source #
An array containing the instance security group IDs.
iEcsClusterARN :: Lens' Instance (Maybe Text) Source #
For container instances, the Amazon ECS cluster's ARN.
iAgentVersion :: 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.
iSubnetId :: Lens' Instance (Maybe Text) Source #
The instance's subnet ID; applicable only if the stack is running in a VPC.
iInfrastructureClass :: Lens' Instance (Maybe Text) Source #
For registered instances, the infrastructure class: ec2 or on-premises .
iSSHHostDsaKeyFingerprint :: Lens' Instance (Maybe Text) Source #
The SSH key's Deep Security Agent (DSA) fingerprint.
iEBSOptimized :: Lens' Instance (Maybe Bool) Source #
Whether this is an Amazon EBS-optimized instance.
iElasticIP :: Lens' Instance (Maybe Text) Source #
The instance Elastic IP address .
iAvailabilityZone :: Lens' Instance (Maybe Text) Source #
The instance Availability Zone. For more information, see Regions and Endpoints .
iLastServiceErrorId :: Lens' Instance (Maybe Text) Source #
The ID of the last service error. For more information, call DescribeServiceErrors .
iTenancy :: Lens' Instance (Maybe Text) Source #
The instance's tenancy option, such as dedicated or host .
iAutoScalingType :: Lens' Instance (Maybe AutoScalingType) Source #
For load-based or time-based instances, the type.
iArchitecture :: Lens' Instance (Maybe Architecture) Source #
The instance architecture: "i386" or "x86_64".
iAMIId :: Lens' Instance (Maybe Text) Source #
A custom AMI ID to be used to create the instance. For more information, see Instances
iReportedOS :: Lens' Instance (Maybe ReportedOS) Source #
For registered instances, the reported operating system.
iRegisteredBy :: Lens' Instance (Maybe Text) Source #
For registered instances, who performed the registration.
iRootDeviceType :: Lens' Instance (Maybe RootDeviceType) Source #
The instance's root device type. For more information, see Storage for the Root Device .
iEcsContainerInstanceARN :: Lens' Instance (Maybe Text) Source #
For container instances, the instance's ARN.
iBlockDeviceMappings :: Lens' Instance [BlockDeviceMapping] Source #
An array of BlockDeviceMapping objects that specify the instance's block device mappings.
InstanceIdentity
data InstanceIdentity Source #
Contains a description of an Amazon EC2 instance from the Amazon EC2 metadata service. For more information, see Instance Metadata and User Data .
See: instanceIdentity smart constructor.
Instances
instanceIdentity :: InstanceIdentity Source #
Creates a value of InstanceIdentity with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
iiSignature- A signature that can be used to verify the document's accuracy and authenticity.iiDocument- A JSON document that contains the metadata.
iiSignature :: Lens' InstanceIdentity (Maybe Text) Source #
A signature that can be used to verify the document's accuracy and authenticity.
iiDocument :: Lens' InstanceIdentity (Maybe Text) Source #
A JSON document that contains the metadata.
InstancesCount
data InstancesCount Source #
Describes how many instances a stack has for each status.
See: instancesCount smart constructor.
Instances
instancesCount :: InstancesCount Source #
Creates a value of InstancesCount with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
icTerminating- The number of instances withterminatingstatus.icPending- The number of instances withpendingstatus.icOnline- The number of instances withonlinestatus.icUnassigning- The number of instances in the Unassigning state.icDeregistering- The number of instances in the Deregistering state.icRunningSetup- The number of instances withrunning_setupstatus.icRequested- The number of instances withrequestedstatus.icStopFailed- Undocumented member.icBooting- The number of instances withbootingstatus.icStopped- The number of instances withstoppedstatus.icRebooting- The number of instances withrebootingstatus.icAssigning- The number of instances in the Assigning state.icShuttingDown- The number of instances withshutting_downstatus.icSetupFailed- The number of instances withsetup_failedstatus.icConnectionLost- The number of instances withconnection_loststatus.icTerminated- The number of instances withterminatedstatus.icStopping- The number of instances withstoppingstatus.icRegistered- The number of instances in the Registered state.icStartFailed- The number of instances withstart_failedstatus.icRegistering- The number of instances in the Registering state.
icTerminating :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with terminating status.
icUnassigning :: Lens' InstancesCount (Maybe Int) Source #
The number of instances in the Unassigning state.
icDeregistering :: Lens' InstancesCount (Maybe Int) Source #
The number of instances in the Deregistering state.
icRunningSetup :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with running_setup status.
icRequested :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with requested status.
icStopFailed :: Lens' InstancesCount (Maybe Int) Source #
Undocumented member.
icRebooting :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with rebooting status.
icAssigning :: Lens' InstancesCount (Maybe Int) Source #
The number of instances in the Assigning state.
icShuttingDown :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with shutting_down status.
icSetupFailed :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with setup_failed status.
icConnectionLost :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with connection_lost status.
icTerminated :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with terminated status.
icStopping :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with stopping status.
icRegistered :: Lens' InstancesCount (Maybe Int) Source #
The number of instances in the Registered state.
icStartFailed :: Lens' InstancesCount (Maybe Int) Source #
The number of instances with start_failed status.
icRegistering :: Lens' InstancesCount (Maybe Int) Source #
The number of instances in the Registering state.
Layer
Describes a layer.
See: layer smart constructor.
Instances
Creates a value of Layer with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lCustomInstanceProfileARN- 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 .lCustomSecurityGroupIds- An array containing the layer's custom security group IDs.lInstallUpdatesOnBoot- Whether to install operating system and package updates when the instance boots. The default value istrue. If this value is set tofalse, you must then update your instances manually by usingCreateDeploymentto run theupdate_dependenciesstack command or manually runningyum(Amazon Linux) orapt-get(Ubuntu) on the instances.lCloudWatchLogsConfiguration- The Amazon CloudWatch Logs configuration settings for the layer.lLifecycleEventConfiguration- ALifeCycleEventConfigurationobject that specifies the Shutdown event configuration.lARN- Undocumented member.lCreatedAt- Date when the layer was created.lShortname- The layer short name.lDefaultRecipes- Undocumented member.lCustomRecipes- ALayerCustomRecipesobject that specifies the layer's custom recipes.lCustomJSON- A JSON formatted string containing the layer's custom stack configuration and deployment attributes.lVolumeConfigurations- AVolumeConfigurationsobject that describes the layer's Amazon EBS volumes.lEnableAutoHealing- Whether auto healing is disabled for the layer.lPackages- An array ofPackageobjects that describe the layer's packages.lAttributes- The layer attributes. For theHaproxyStatsPassword,MysqlRootPassword, andGangliaPasswordattributes, AWS OpsWorks Stacks returns*****FILTERED*****instead of the actual value For an ECS Cluster layer, AWS OpsWorks Stacks theEcsClusterArnattribute is set to the cluster's ARN.lName- The layer name.lAutoAssignPublicIPs- 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 .lType- The layer type.lUseEBSOptimizedInstances- Whether the layer uses Amazon EBS-optimized instances.lStackId- The layer stack ID.lLayerId- The layer ID.lDefaultSecurityGroupNames- An array containing the layer's security group names.lAutoAssignElasticIPs- Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer .
lCustomInstanceProfileARN :: 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 .
lCustomSecurityGroupIds :: Lens' Layer [Text] Source #
An array containing the layer's custom security group IDs.
lInstallUpdatesOnBoot :: 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.
lCloudWatchLogsConfiguration :: Lens' Layer (Maybe CloudWatchLogsConfiguration) Source #
The Amazon CloudWatch Logs configuration settings for the layer.
lLifecycleEventConfiguration :: Lens' Layer (Maybe LifecycleEventConfiguration) Source #
A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
lCustomRecipes :: Lens' Layer (Maybe Recipes) Source #
A LayerCustomRecipes object that specifies the layer's custom recipes.
lCustomJSON :: Lens' Layer (Maybe Text) Source #
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
lVolumeConfigurations :: Lens' Layer [VolumeConfiguration] Source #
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
lEnableAutoHealing :: Lens' Layer (Maybe Bool) Source #
Whether auto healing is disabled for the layer.
lPackages :: Lens' Layer [Text] Source #
An array of Package objects that describe the layer's packages.
lAttributes :: Lens' Layer (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.
lAutoAssignPublicIPs :: 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 .
lUseEBSOptimizedInstances :: Lens' Layer (Maybe Bool) Source #
Whether the layer uses Amazon EBS-optimized instances.
lDefaultSecurityGroupNames :: Lens' Layer [Text] Source #
An array containing the layer's security group names.
lAutoAssignElasticIPs :: 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
data LifecycleEventConfiguration Source #
Specifies the lifecycle event configuration
See: lifecycleEventConfiguration smart constructor.
Instances
lifecycleEventConfiguration :: LifecycleEventConfiguration Source #
Creates a value of LifecycleEventConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lecShutdown- AShutdownEventConfigurationobject that specifies the Shutdown event configuration.
lecShutdown :: Lens' LifecycleEventConfiguration (Maybe ShutdownEventConfiguration) Source #
A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
LoadBasedAutoScalingConfiguration
data LoadBasedAutoScalingConfiguration Source #
Describes a layer's load-based auto scaling configuration.
See: loadBasedAutoScalingConfiguration smart constructor.
Instances
loadBasedAutoScalingConfiguration :: LoadBasedAutoScalingConfiguration Source #
Creates a value of LoadBasedAutoScalingConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
lbascUpScaling- AnAutoScalingThresholdsobject that describes the upscaling configuration, which defines how and when AWS OpsWorks Stacks increases the number of instances.lbascEnable- Whether load-based auto scaling is enabled for the layer.lbascDownScaling- AnAutoScalingThresholdsobject that describes the downscaling configuration, which defines how and when AWS OpsWorks Stacks reduces the number of instances.lbascLayerId- The layer ID.
lbascUpScaling :: 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.
lbascEnable :: Lens' LoadBasedAutoScalingConfiguration (Maybe Bool) Source #
Whether load-based auto scaling is enabled for the layer.
lbascDownScaling :: 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.
lbascLayerId :: Lens' LoadBasedAutoScalingConfiguration (Maybe Text) Source #
The layer ID.
OperatingSystem
data OperatingSystem Source #
Describes supported operating systems in AWS OpsWorks Stacks.
See: operatingSystem smart constructor.
Instances
operatingSystem :: OperatingSystem Source #
Creates a value of OperatingSystem with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
osReportedVersion- The version of the operating system, including the release and edition, if applicable.osSupported- Indicates that an operating system is not supported for new instances.osName- The name of the operating system, such asAmazon Linux 2017.09.osId- The ID of a supported operating system, such asAmazon Linux 2017.09.osConfigurationManagers- Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.osType- The type of a supported operating system, eitherLinuxorWindows.osReportedName- A short name for the operating system manufacturer.
osReportedVersion :: Lens' OperatingSystem (Maybe Text) Source #
The version of the operating system, including the release and edition, if applicable.
osSupported :: Lens' OperatingSystem (Maybe Bool) Source #
Indicates that an operating system is not supported for new instances.
osName :: Lens' OperatingSystem (Maybe Text) Source #
The name of the operating system, such as Amazon Linux 2017.09 .
osId :: Lens' OperatingSystem (Maybe Text) Source #
The ID of a supported operating system, such as Amazon Linux 2017.09 .
osConfigurationManagers :: Lens' OperatingSystem [OperatingSystemConfigurationManager] Source #
Supported configuration manager name and versions for an AWS OpsWorks Stacks operating system.
osType :: Lens' OperatingSystem (Maybe Text) Source #
The type of a supported operating system, either Linux or Windows .
osReportedName :: Lens' OperatingSystem (Maybe Text) Source #
A short name for the operating system manufacturer.
OperatingSystemConfigurationManager
data OperatingSystemConfigurationManager Source #
A block that contains information about the configuration manager (Chef) and the versions of the configuration manager that are supported for an operating system.
See: operatingSystemConfigurationManager smart constructor.
Instances
operatingSystemConfigurationManager :: OperatingSystemConfigurationManager Source #
Creates a value of OperatingSystemConfigurationManager with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
oscmName- The name of the configuration manager, which is Chef.oscmVersion- The versions of the configuration manager that are supported by an operating system.
oscmName :: Lens' OperatingSystemConfigurationManager (Maybe Text) Source #
The name of the configuration manager, which is Chef.
oscmVersion :: Lens' OperatingSystemConfigurationManager (Maybe Text) Source #
The versions of the configuration manager that are supported by an operating system.
Permission
data Permission Source #
Describes stack or user permissions.
See: permission smart constructor.
Instances
permission :: Permission Source #
Creates a value of Permission with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pIAMUserARN- The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers .pAllowSudo- Whether the user can use sudo .pStackId- A stack ID.pLevel- The user's permission level, which must be the following: *deny*show*deploy*manage*iam_onlyFor more information on the permissions associated with these levels, see Managing User PermissionspAllowSSH- Whether the user can use SSH.
pIAMUserARN :: 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 .
pAllowSudo :: Lens' Permission (Maybe Bool) Source #
Whether the user can use sudo .
pLevel :: 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
RAIdArray
Describes an instance's RAID array.
See: rAIdArray smart constructor.
Instances
rAIdArray :: RAIdArray Source #
Creates a value of RAIdArray with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
raiaInstanceId- The instance ID.raiaSize- The array's size.raiaIOPS- For PIOPS volumes, the IOPS per disk.raiaCreatedAt- When the RAID array was created.raiaRAIdLevel- The RAID level .raiaDevice- The array's Linux device. For example devmdadm0.raiaNumberOfDisks- The number of disks in the array.raiaAvailabilityZone- The array's Availability Zone. For more information, see Regions and Endpoints .raiaName- The array name.raiaRAIdArrayId- The array ID.raiaVolumeType- The volume type, standard or PIOPS.raiaStackId- The stack ID.raiaMountPoint- The array's mount point.
raiaRAIdLevel :: Lens' RAIdArray (Maybe Int) Source #
The RAID level .
raiaAvailabilityZone :: Lens' RAIdArray (Maybe Text) Source #
The array's Availability Zone. For more information, see Regions and Endpoints .
RDSDBInstance
data RDSDBInstance Source #
Describes an Amazon RDS instance.
See: rdsDBInstance smart constructor.
Instances
rdsDBInstance :: RDSDBInstance Source #
Creates a value of RDSDBInstance with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rdiRDSDBInstanceARN- The instance's ARN.rdiDBUser- The master user name.rdiMissingOnRDS- Set totrueif 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 totrue, you must deregister the instance, and then register it again.rdiEngine- The instance's database engine.rdiAddress- The instance's address.rdiDBInstanceIdentifier- The DB instance identifier.rdiRegion- The instance's AWS region.rdiStackId- The ID of the stack with which the instance is registered.rdiDBPassword- AWS OpsWorks Stacks returns*****FILTERED*****instead of the actual value.
rdiRDSDBInstanceARN :: Lens' RDSDBInstance (Maybe Text) Source #
The instance's ARN.
rdiMissingOnRDS :: 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.
rdiAddress :: Lens' RDSDBInstance (Maybe Text) Source #
The instance's address.
rdiDBInstanceIdentifier :: Lens' RDSDBInstance (Maybe Text) Source #
The DB instance identifier.
rdiStackId :: Lens' RDSDBInstance (Maybe Text) Source #
The ID of the stack with which the instance is registered.
rdiDBPassword :: Lens' RDSDBInstance (Maybe Text) Source #
AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
Recipes
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. In addition, you can 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.
See: recipes smart constructor.
Instances
Creates a value of Recipes with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
rSetup- An array of custom recipe names to be run following asetupevent.rShutdown- An array of custom recipe names to be run following ashutdownevent.rUndeploy- An array of custom recipe names to be run following aundeployevent.rConfigure- An array of custom recipe names to be run following aconfigureevent.rDeploy- An array of custom recipe names to be run following adeployevent.
rSetup :: Lens' Recipes [Text] Source #
An array of custom recipe names to be run following a setup event.
rShutdown :: Lens' Recipes [Text] Source #
An array of custom recipe names to be run following a shutdown event.
rUndeploy :: Lens' Recipes [Text] Source #
An array of custom recipe names to be run following a undeploy event.
rConfigure :: Lens' Recipes [Text] Source #
An array of custom recipe names to be run following a configure event.
rDeploy :: Lens' Recipes [Text] Source #
An array of custom recipe names to be run following a deploy event.
ReportedOS
data ReportedOS Source #
A registered instance's reported operating system.
See: reportedOS smart constructor.
Instances
reportedOS :: ReportedOS Source #
Creates a value of ReportedOS with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
SSLConfiguration
data SSLConfiguration Source #
Describes an app's SSL configuration.
See: sslConfiguration smart constructor.
Instances
sslConfiguration :: SSLConfiguration Source #
Creates a value of SSLConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scPrivateKey- The private key; the contents of the certificate's domain.kex file.scCertificate- The contents of the certificate's domain.crt file.scChain- Optional. Can be used to specify an intermediate certificate authority key or client authentication.
scPrivateKey :: Lens' SSLConfiguration (Maybe Text) Source #
The private key; the contents of the certificate's domain.kex file.
scCertificate :: Lens' SSLConfiguration (Maybe Text) Source #
The contents of the certificate's domain.crt file.
scChain :: Lens' SSLConfiguration (Maybe Text) Source #
Optional. Can be used to specify an intermediate certificate authority key or client authentication.
SelfUserProfile
data SelfUserProfile Source #
Describes a user's SSH information.
See: selfUserProfile smart constructor.
Instances
selfUserProfile :: SelfUserProfile Source #
Creates a value of SelfUserProfile with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
supSSHPublicKey- The user's SSH public key.supSSHUsername- The user's SSH user name.supIAMUserARN- The user's IAM ARN.supName- The user's name.
supSSHPublicKey :: Lens' SelfUserProfile (Maybe Text) Source #
The user's SSH public key.
supSSHUsername :: Lens' SelfUserProfile (Maybe Text) Source #
The user's SSH user name.
supIAMUserARN :: Lens' SelfUserProfile (Maybe Text) Source #
The user's IAM ARN.
ServiceError'
data ServiceError' Source #
Describes an AWS OpsWorks Stacks service error.
See: serviceError' smart constructor.
Instances
serviceError' :: ServiceError' Source #
Creates a value of ServiceError' with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
seInstanceId- The instance ID.seCreatedAt- When the error occurred.seServiceErrorId- The error ID.seType- The error type.seStackId- The stack ID.seMessage- A message that describes the error.
seInstanceId :: Lens' ServiceError' (Maybe Text) Source #
The instance ID.
seCreatedAt :: Lens' ServiceError' (Maybe Text) Source #
When the error occurred.
seServiceErrorId :: Lens' ServiceError' (Maybe Text) Source #
The error ID.
ShutdownEventConfiguration
data ShutdownEventConfiguration Source #
The Shutdown event configuration.
See: shutdownEventConfiguration smart constructor.
Instances
shutdownEventConfiguration :: ShutdownEventConfiguration Source #
Creates a value of ShutdownEventConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
secExecutionTimeout- The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.secDelayUntilElbConnectionsDrained- Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
secExecutionTimeout :: 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.
secDelayUntilElbConnectionsDrained :: Lens' ShutdownEventConfiguration (Maybe Bool) Source #
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
Source
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks .
See: source smart constructor.
Instances
Creates a value of Source with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sURL- 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.sUsername- This parameter depends on the repository type. * For Amazon S3 bundles, setUsernameto the appropriate IAM access key ID. * For HTTP bundles, Git repositories, and Subversion repositories, setUsernameto the user name.sSSHKey- In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns*****FILTERED*****instead of the actual value.sPassword- When included in a request, the parameter depends on the repository type. * For Amazon S3 bundles, setPasswordto the appropriate IAM secret access key. * For HTTP bundles and Subversion repositories, setPasswordto the password. For more information on how to safely handle IAM credentials, see http://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.sType- The repository type.sRevision- 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.
sURL :: 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 .
sUsername :: 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.
sSSHKey :: Lens' Source (Maybe Text) Source #
In requests, the repository's SSH key. In responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.
sPassword :: 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 http://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.
sRevision :: 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.
Stack
Describes a stack.
See: stack smart constructor.
Instances
Creates a value of Stack with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
sDefaultInstanceProfileARN- 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 .sServiceRoleARN- The stack AWS Identity and Access Management (IAM) role.sDefaultRootDeviceType- 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 .sARN- The stack's ARN.sCreatedAt- The date when the stack was created.sVPCId- The VPC ID; applicable only if the stack is running in a VPC.sChefConfiguration- AChefConfigurationobject that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack .sAgentVersion- The agent version. This parameter is set toLATESTfor auto-update. or a version number for a fixed agent version.sDefaultSSHKeyName- A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.sCustomJSON- 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 .sCustomCookbooksSource- Undocumented member.sDefaultAvailabilityZone- The stack's default Availability Zone. For more information, see Regions and Endpoints .sAttributes- The stack's attributes.sName- The stack name.sDefaultOS- The stack's default operating system.sUseOpsworksSecurityGroups- Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.sUseCustomCookbooks- Whether the stack uses custom cookbooks.sDefaultSubnetId- The default subnet ID; applicable only if the stack is running in a VPC.sRegion- The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints .sConfigurationManager- The configuration manager.sStackId- The stack ID.sHostnameTheme- The stack host name theme, with spaces replaced by underscores.
sDefaultInstanceProfileARN :: 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 .
sServiceRoleARN :: Lens' Stack (Maybe Text) Source #
The stack AWS Identity and Access Management (IAM) role.
sDefaultRootDeviceType :: 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 .
sVPCId :: Lens' Stack (Maybe Text) Source #
The VPC ID; applicable only if the stack is running in a VPC.
sChefConfiguration :: 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 .
sAgentVersion :: 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.
sDefaultSSHKeyName :: 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.
sCustomJSON :: 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 .
sDefaultAvailabilityZone :: Lens' Stack (Maybe Text) Source #
The stack's default Availability Zone. For more information, see Regions and Endpoints .
sAttributes :: Lens' Stack (HashMap StackAttributesKeys (Maybe Text)) Source #
The stack's attributes.
sUseOpsworksSecurityGroups :: Lens' Stack (Maybe Bool) Source #
Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.
sDefaultSubnetId :: Lens' Stack (Maybe Text) Source #
The default subnet ID; applicable only if the stack is running in a VPC.
sRegion :: Lens' Stack (Maybe Text) Source #
The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints .
sConfigurationManager :: Lens' Stack (Maybe StackConfigurationManager) Source #
The configuration manager.
sHostnameTheme :: Lens' Stack (Maybe Text) Source #
The stack host name theme, with spaces replaced by underscores.
StackConfigurationManager
data StackConfigurationManager Source #
Describes the configuration manager.
See: stackConfigurationManager smart constructor.
Instances
stackConfigurationManager :: StackConfigurationManager Source #
Creates a value of StackConfigurationManager with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
scmName- The name. This parameter must be set to Chef.scmVersion- 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.
scmName :: Lens' StackConfigurationManager (Maybe Text) Source #
The name. This parameter must be set to Chef.
scmVersion :: 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
data StackSummary Source #
Summarizes the number of layers, instances, and apps in a stack.
See: stackSummary smart constructor.
Instances
stackSummary :: StackSummary Source #
Creates a value of StackSummary with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
ssARN- The stack's ARN.ssAppsCount- The number of apps.ssName- The stack name.ssStackId- The stack ID.ssLayersCount- The number of layers.ssInstancesCount- AnInstancesCountobject with the number of instances in each status.
ssAppsCount :: Lens' StackSummary (Maybe Int) Source #
The number of apps.
ssLayersCount :: Lens' StackSummary (Maybe Int) Source #
The number of layers.
ssInstancesCount :: Lens' StackSummary (Maybe InstancesCount) Source #
An InstancesCount object with the number of instances in each status.
TemporaryCredential
data TemporaryCredential Source #
Contains the data needed by RDP clients such as the Microsoft Remote Desktop Connection to log in to the instance.
See: temporaryCredential smart constructor.
Instances
temporaryCredential :: TemporaryCredential Source #
Creates a value of TemporaryCredential with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tcInstanceId- The instance's AWS OpsWorks Stacks ID.tcUsername- The user name.tcPassword- The password.tcValidForInMinutes- 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.
tcInstanceId :: Lens' TemporaryCredential (Maybe Text) Source #
The instance's AWS OpsWorks Stacks ID.
tcUsername :: Lens' TemporaryCredential (Maybe Text) Source #
The user name.
tcPassword :: Lens' TemporaryCredential (Maybe Text) Source #
The password.
tcValidForInMinutes :: 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
data TimeBasedAutoScalingConfiguration Source #
Describes an instance's time-based auto scaling configuration.
See: timeBasedAutoScalingConfiguration smart constructor.
Instances
timeBasedAutoScalingConfiguration :: TimeBasedAutoScalingConfiguration Source #
Creates a value of TimeBasedAutoScalingConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
tbascInstanceId- The instance ID.tbascAutoScalingSchedule- AWeeklyAutoScalingScheduleobject with the instance schedule.
tbascInstanceId :: Lens' TimeBasedAutoScalingConfiguration (Maybe Text) Source #
The instance ID.
tbascAutoScalingSchedule :: Lens' TimeBasedAutoScalingConfiguration (Maybe WeeklyAutoScalingSchedule) Source #
A WeeklyAutoScalingSchedule object with the instance schedule.
UserProfile
data UserProfile Source #
Describes a user's SSH information.
See: userProfile smart constructor.
Instances
userProfile :: UserProfile Source #
Creates a value of UserProfile with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
upAllowSelfManagement- Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions .upSSHPublicKey- The user's SSH public key.upSSHUsername- The user's SSH user name.upIAMUserARN- The user's IAM ARN.upName- The user's name.
upAllowSelfManagement :: 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 .
upSSHPublicKey :: Lens' UserProfile (Maybe Text) Source #
The user's SSH public key.
upSSHUsername :: Lens' UserProfile (Maybe Text) Source #
The user's SSH user name.
upIAMUserARN :: Lens' UserProfile (Maybe Text) Source #
The user's IAM ARN.
Volume
Describes an instance's Amazon EBS volume.
See: volume smart constructor.
Instances
Creates a value of Volume with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vInstanceId- The instance ID.vStatus- The value returned by DescribeVolumes .vSize- The volume size.vIOPS- For PIOPS volumes, the IOPS per disk.vDevice- The device name.vEncrypted- Undocumented member.vAvailabilityZone- The volume Availability Zone. For more information, see Regions and Endpoints .vName- The volume name.vRAIdArrayId- The RAID array ID.vVolumeId- The volume ID.vRegion- The AWS region. For more information about AWS regions, see Regions and Endpoints .vVolumeType- The volume type, standard or PIOPS.vEC2VolumeId- The Amazon EC2 volume ID.vMountPoint- The volume mount point. For example, "mntdisk1".
vAvailabilityZone :: Lens' Volume (Maybe Text) Source #
The volume Availability Zone. For more information, see Regions and Endpoints .
vRegion :: Lens' Volume (Maybe Text) Source #
The AWS region. For more information about AWS regions, see Regions and Endpoints .
VolumeConfiguration
data VolumeConfiguration Source #
Describes an Amazon EBS volume configuration.
See: volumeConfiguration smart constructor.
Instances
Arguments
| :: Text | |
| -> Int | |
| -> Int | |
| -> VolumeConfiguration |
Creates a value of VolumeConfiguration with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vcIOPS- For PIOPS volumes, the IOPS per disk.vcRAIdLevel- The volume RAID level .vcEncrypted- Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption .vcVolumeType- The volume type. For more information, see Amazon EBS Volume Types . *standard- Magnetic *io1- Provisioned IOPS (SSD) *gp2- General Purpose (SSD) *st1- Throughput Optimized hard disk drive (HDD) *sc1- Cold HDDvcMountPoint- The volume mount point. For example "devsdh".vcNumberOfDisks- The number of disks in the volume.vcSize- The volume size.
vcRAIdLevel :: Lens' VolumeConfiguration (Maybe Int) Source #
The volume RAID level .
vcEncrypted :: Lens' VolumeConfiguration (Maybe Bool) Source #
Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption .
vcVolumeType :: Lens' VolumeConfiguration (Maybe Text) Source #
The volume type. For more information, see Amazon EBS Volume Types . * standard - Magnetic * io1 - Provisioned IOPS (SSD) * gp2 - General Purpose (SSD) * st1 - Throughput Optimized hard disk drive (HDD) * sc1 - Cold HDD
vcMountPoint :: Lens' VolumeConfiguration Text Source #
The volume mount point. For example "devsdh".
vcNumberOfDisks :: Lens' VolumeConfiguration Int Source #
The number of disks in the volume.
WeeklyAutoScalingSchedule
data WeeklyAutoScalingSchedule Source #
Describes a time-based instance's auto scaling schedule. The schedule consists of a set of key-value pairs.
- The key is the time period (a UTC hour) and must be an integer from 0 - 23.
- The value indicates whether the instance should be online or offline for the specified period, and must be set to "on" or "off"
The default setting for all time periods is off, so you use the following parameters primarily to specify the online periods. You don't have to explicitly specify offline periods unless you want to change an online period to an offline period.
The following example specifies that the instance should be online for four hours, from UTC 1200 - 1600. It will be off for the remainder of the day.
{ "12":"on", "13":"on", "14":"on", "15":"on" }See: weeklyAutoScalingSchedule smart constructor.
Instances
weeklyAutoScalingSchedule :: WeeklyAutoScalingSchedule Source #
Creates a value of WeeklyAutoScalingSchedule with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wassThursday- The schedule for Thursday.wassWednesday- The schedule for Wednesday.wassSaturday- The schedule for Saturday.wassMonday- The schedule for Monday.wassFriday- The schedule for Friday.wassSunday- The schedule for Sunday.wassTuesday- The schedule for Tuesday.
wassThursday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text) Source #
The schedule for Thursday.
wassWednesday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text) Source #
The schedule for Wednesday.
wassSaturday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text) Source #
The schedule for Saturday.
wassMonday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text) Source #
The schedule for Monday.
wassFriday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text) Source #
The schedule for Friday.
wassSunday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text) Source #
The schedule for Sunday.
wassTuesday :: Lens' WeeklyAutoScalingSchedule (HashMap Text Text) Source #
The schedule for Tuesday.