Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
- Service Configuration
- Errors
- Waiters
- Operations
- DescribeRDSDBInstances
- DeleteStack
- UpdateStack
- CreateLayer
- SetLoadBasedAutoScaling
- UnassignVolume
- DeregisterRDSDBInstance
- CreateInstance
- RegisterElasticIP
- DescribeAgentVersions
- DescribeLayers
- CreateDeployment
- DeleteApp
- UpdateApp
- DeleteInstance
- UpdateInstance
- DescribeStacks
- DeregisterVolume
- AssignInstance
- RebootInstance
- DescribeTimeBasedAutoScaling
- UpdateRDSDBInstance
- StopStack
- DescribeVolumes
- DisassociateElasticIP
- RegisterEcsCluster
- StopInstance
- RegisterVolume
- SetTimeBasedAutoScaling
- DeregisterElasticIP
- AttachElasticLoadBalancer
- DescribeUserProfiles
- DescribeStackSummary
- DeregisterEcsCluster
- DescribeApps
- UpdateMyUserProfile
- DescribeInstances
- DescribeDeployments
- CreateStack
- GrantAccess
- DescribeElasticIPs
- DeleteLayer
- UpdateLayer
- CloneStack
- GetHostnameSuggestion
- CreateApp
- DescribePermissions
- UpdateElasticIP
- DescribeLoadBasedAutoScaling
- RegisterInstance
- AssociateElasticIP
- DetachElasticLoadBalancer
- DescribeStackProvisioningParameters
- DescribeMyUserProfile
- UnassignInstance
- RegisterRDSDBInstance
- DeleteUserProfile
- UpdateUserProfile
- DescribeServiceErrors
- StartStack
- CreateUserProfile
- DescribeCommands
- DescribeEcsClusters
- DescribeElasticLoadBalancers
- DeregisterInstance
- DescribeRAIdArrays
- SetPermission
- UpdateVolume
- AssignVolume
- StartInstance
- Types
- AppAttributesKeys
- AppType
- Architecture
- AutoScalingType
- DeploymentCommandName
- LayerAttributesKeys
- LayerType
- RootDeviceType
- SourceType
- StackAttributesKeys
- VirtualizationType
- VolumeType
- AgentVersion
- App
- AutoScalingThresholds
- BlockDeviceMapping
- ChefConfiguration
- Command
- DataSource
- Deployment
- DeploymentCommand
- EBSBlockDevice
- EcsCluster
- ElasticIP
- ElasticLoadBalancer
- EnvironmentVariable
- Instance
- InstanceIdentity
- InstancesCount
- Layer
- LifecycleEventConfiguration
- LoadBasedAutoScalingConfiguration
- Permission
- RAIdArray
- RDSDBInstance
- Recipes
- ReportedOS
- SSLConfiguration
- SelfUserProfile
- ServiceError'
- ShutdownEventConfiguration
- Source
- Stack
- StackConfigurationManager
- StackSummary
- TemporaryCredential
- TimeBasedAutoScalingConfiguration
- UserProfile
- Volume
- VolumeConfiguration
- WeeklyAutoScalingSchedule
AWS OpsWorks
Welcome to the AWS OpsWorks API Reference. This guide provides descriptions, syntax, and usage examples about AWS OpsWorks actions and data types, including common parameters and error codes.
AWS OpsWorks 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 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 supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.
Chef Versions
When you call CreateStack, CloneStack, or UpdateStack we recommend you
use the ConfigurationManager
parameter to specify the Chef version.
The recommended value for Linux stacks, which is also the default value,
is currently 11.10. Windows stacks use Chef 12.2. For more information,
see
Chef Versions.
You can also specify Chef 11.4 or Chef 0.9 for your Linux stack. However, Chef 0.9 has been deprecated. We do not recommend using Chef 0.9 for new stacks, and we recommend migrating your existing Chef 0.9 stacks to Chef 11.10 as soon as possible.
See: AWS API Reference
- opsWorks :: Service
- _ValidationException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- 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.UnassignVolume
- module Network.AWS.OpsWorks.DeregisterRDSDBInstance
- module Network.AWS.OpsWorks.CreateInstance
- module Network.AWS.OpsWorks.RegisterElasticIP
- module Network.AWS.OpsWorks.DescribeAgentVersions
- module Network.AWS.OpsWorks.DescribeLayers
- module Network.AWS.OpsWorks.CreateDeployment
- module Network.AWS.OpsWorks.DeleteApp
- module Network.AWS.OpsWorks.UpdateApp
- module Network.AWS.OpsWorks.DeleteInstance
- module Network.AWS.OpsWorks.UpdateInstance
- module Network.AWS.OpsWorks.DescribeStacks
- module Network.AWS.OpsWorks.DeregisterVolume
- module Network.AWS.OpsWorks.AssignInstance
- module Network.AWS.OpsWorks.RebootInstance
- module Network.AWS.OpsWorks.DescribeTimeBasedAutoScaling
- module Network.AWS.OpsWorks.UpdateRDSDBInstance
- 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.DeregisterElasticIP
- module Network.AWS.OpsWorks.AttachElasticLoadBalancer
- module Network.AWS.OpsWorks.DescribeUserProfiles
- module Network.AWS.OpsWorks.DescribeStackSummary
- module Network.AWS.OpsWorks.DeregisterEcsCluster
- module Network.AWS.OpsWorks.DescribeApps
- module Network.AWS.OpsWorks.UpdateMyUserProfile
- module Network.AWS.OpsWorks.DescribeInstances
- module Network.AWS.OpsWorks.DescribeDeployments
- module Network.AWS.OpsWorks.CreateStack
- module Network.AWS.OpsWorks.GrantAccess
- module Network.AWS.OpsWorks.DescribeElasticIPs
- module Network.AWS.OpsWorks.DeleteLayer
- module Network.AWS.OpsWorks.UpdateLayer
- module Network.AWS.OpsWorks.CloneStack
- module Network.AWS.OpsWorks.GetHostnameSuggestion
- module Network.AWS.OpsWorks.CreateApp
- module Network.AWS.OpsWorks.DescribePermissions
- module Network.AWS.OpsWorks.UpdateElasticIP
- module Network.AWS.OpsWorks.DescribeLoadBasedAutoScaling
- module Network.AWS.OpsWorks.RegisterInstance
- module Network.AWS.OpsWorks.AssociateElasticIP
- module Network.AWS.OpsWorks.DetachElasticLoadBalancer
- module Network.AWS.OpsWorks.DescribeStackProvisioningParameters
- module Network.AWS.OpsWorks.DescribeMyUserProfile
- module Network.AWS.OpsWorks.UnassignInstance
- module Network.AWS.OpsWorks.RegisterRDSDBInstance
- module Network.AWS.OpsWorks.DeleteUserProfile
- module Network.AWS.OpsWorks.UpdateUserProfile
- module Network.AWS.OpsWorks.DescribeServiceErrors
- module Network.AWS.OpsWorks.StartStack
- module Network.AWS.OpsWorks.CreateUserProfile
- module Network.AWS.OpsWorks.DescribeCommands
- module Network.AWS.OpsWorks.DescribeEcsClusters
- module Network.AWS.OpsWorks.DescribeElasticLoadBalancers
- module Network.AWS.OpsWorks.DeregisterInstance
- module Network.AWS.OpsWorks.DescribeRAIdArrays
- module Network.AWS.OpsWorks.SetPermission
- module Network.AWS.OpsWorks.UpdateVolume
- module Network.AWS.OpsWorks.AssignVolume
- module Network.AWS.OpsWorks.StartInstance
- data AppAttributesKeys
- data AppType
- data Architecture
- data AutoScalingType
- 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)
- appShortname :: Lens' App (Maybe Text)
- appEnableSSL :: Lens' App (Maybe Bool)
- appCreatedAt :: Lens' App (Maybe Text)
- appEnvironment :: Lens' App [EnvironmentVariable]
- appDataSources :: Lens' App [DataSource]
- appAppId :: Lens' App (Maybe Text)
- appAppSource :: Lens' App (Maybe Source)
- appName :: Lens' App (Maybe Text)
- appAttributes :: Lens' App (HashMap AppAttributesKeys Text)
- appType :: Lens' App (Maybe AppType)
- appDomains :: Lens' App [Text]
- appStackId :: Lens' App (Maybe 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 Command
- command :: Command
- cInstanceId :: Lens' Command (Maybe Text)
- cDeploymentId :: 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)
- elbEC2InstanceIds :: Lens' ElasticLoadBalancer [Text]
- elbStackId :: Lens' ElasticLoadBalancer (Maybe 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
- iInstanceId :: Lens' Instance (Maybe Text)
- iPrivateIP :: Lens' Instance (Maybe Text)
- iInstallUpdatesOnBoot :: Lens' Instance (Maybe Bool)
- iReportedAgentVersion :: Lens' Instance (Maybe Text)
- iStatus :: Lens' Instance (Maybe Text)
- iPrivateDNS :: Lens' Instance (Maybe Text)
- iVirtualizationType :: Lens' Instance (Maybe VirtualizationType)
- iSecurityGroupIds :: Lens' Instance [Text]
- iSSHHostRsaKeyFingerprint :: Lens' Instance (Maybe Text)
- iInstanceProfileARN :: Lens' Instance (Maybe Text)
- iPlatform :: Lens' Instance (Maybe Text)
- iHostname :: Lens' Instance (Maybe Text)
- iEcsClusterARN :: Lens' Instance (Maybe Text)
- iCreatedAt :: Lens' Instance (Maybe Text)
- iSSHKeyName :: Lens' Instance (Maybe Text)
- iEC2InstanceId :: Lens' Instance (Maybe Text)
- iAgentVersion :: Lens' Instance (Maybe Text)
- iRootDeviceVolumeId :: Lens' Instance (Maybe Text)
- iSubnetId :: Lens' Instance (Maybe Text)
- iInstanceType :: Lens' Instance (Maybe Text)
- iInfrastructureClass :: Lens' Instance (Maybe Text)
- iEBSOptimized :: Lens' Instance (Maybe Bool)
- iSSHHostDsaKeyFingerprint :: Lens' Instance (Maybe Text)
- iElasticIP :: Lens' Instance (Maybe Text)
- iOS :: Lens' Instance (Maybe Text)
- iAvailabilityZone :: Lens' Instance (Maybe Text)
- iLastServiceErrorId :: Lens' Instance (Maybe Text)
- iAutoScalingType :: Lens' Instance (Maybe AutoScalingType)
- iLayerIds :: Lens' Instance [Text]
- iArchitecture :: Lens' Instance (Maybe Architecture)
- iPublicDNS :: Lens' Instance (Maybe Text)
- iPublicIP :: Lens' Instance (Maybe Text)
- iAMIId :: Lens' Instance (Maybe Text)
- iReportedOS :: Lens' Instance (Maybe ReportedOS)
- iStackId :: Lens' Instance (Maybe Text)
- iRegisteredBy :: Lens' Instance (Maybe Text)
- iBlockDeviceMappings :: Lens' Instance [BlockDeviceMapping]
- iEcsContainerInstanceARN :: Lens' Instance (Maybe Text)
- iRootDeviceType :: Lens' Instance (Maybe RootDeviceType)
- 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)
- icRequested :: Lens' InstancesCount (Maybe Int)
- icRunningSetup :: Lens' InstancesCount (Maybe Int)
- icDeregistering :: 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)
- lInstallUpdatesOnBoot :: Lens' Layer (Maybe Bool)
- lCustomSecurityGroupIds :: Lens' Layer [Text]
- lLifecycleEventConfiguration :: Lens' Layer (Maybe LifecycleEventConfiguration)
- lShortname :: Lens' Layer (Maybe Text)
- lCreatedAt :: Lens' Layer (Maybe Text)
- lDefaultRecipes :: Lens' Layer (Maybe Recipes)
- lCustomRecipes :: Lens' Layer (Maybe Recipes)
- lVolumeConfigurations :: Lens' Layer [VolumeConfiguration]
- lCustomJSON :: Lens' Layer (Maybe Text)
- lEnableAutoHealing :: Lens' Layer (Maybe Bool)
- lPackages :: Lens' Layer [Text]
- lName :: Lens' Layer (Maybe Text)
- lAttributes :: Lens' Layer (HashMap LayerAttributesKeys Text)
- lAutoAssignPublicIPs :: Lens' Layer (Maybe Bool)
- lUseEBSOptimizedInstances :: Lens' Layer (Maybe Bool)
- lType :: Lens' Layer (Maybe LayerType)
- 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 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)
- raiaCreatedAt :: Lens' RAIdArray (Maybe Text)
- raiaIOPS :: Lens' RAIdArray (Maybe Int)
- raiaRAIdLevel :: Lens' RAIdArray (Maybe Int)
- raiaDevice :: Lens' RAIdArray (Maybe Text)
- raiaNumberOfDisks :: Lens' RAIdArray (Maybe Int)
- raiaName :: Lens' RAIdArray (Maybe Text)
- raiaAvailabilityZone :: 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
- rdiDBUser :: Lens' RDSDBInstance (Maybe Text)
- rdiRDSDBInstanceARN :: 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]
- rUndeploy :: Lens' Recipes [Text]
- rShutdown :: 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 :: Text -> Text -> SSLConfiguration
- scChain :: Lens' SSLConfiguration (Maybe Text)
- scCertificate :: Lens' SSLConfiguration Text
- scPrivateKey :: Lens' SSLConfiguration Text
- data SelfUserProfile
- selfUserProfile :: SelfUserProfile
- supSSHUsername :: Lens' SelfUserProfile (Maybe Text)
- supSSHPublicKey :: 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)
- seMessage :: Lens' ServiceError' (Maybe Text)
- seStackId :: 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)
- sARN :: Lens' Stack (Maybe Text)
- sDefaultRootDeviceType :: Lens' Stack (Maybe RootDeviceType)
- sCreatedAt :: Lens' Stack (Maybe Text)
- sChefConfiguration :: Lens' Stack (Maybe ChefConfiguration)
- sVPCId :: Lens' Stack (Maybe Text)
- 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)
- sName :: Lens' Stack (Maybe Text)
- sUseOpsworksSecurityGroups :: Lens' Stack (Maybe Bool)
- sDefaultOS :: Lens' Stack (Maybe Text)
- sAttributes :: Lens' Stack (HashMap StackAttributesKeys Text)
- 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
- upSSHUsername :: Lens' UserProfile (Maybe Text)
- upSSHPublicKey :: Lens' UserProfile (Maybe Text)
- upAllowSelfManagement :: Lens' UserProfile (Maybe Bool)
- 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)
- vName :: Lens' Volume (Maybe Text)
- vAvailabilityZone :: 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)
- 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 invalid.
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.
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
UnassignVolume
DeregisterRDSDBInstance
CreateInstance
RegisterElasticIP
DescribeAgentVersions
DescribeLayers
CreateDeployment
DeleteApp
UpdateApp
DeleteInstance
UpdateInstance
DescribeStacks
DeregisterVolume
AssignInstance
RebootInstance
DescribeTimeBasedAutoScaling
UpdateRDSDBInstance
StopStack
DescribeVolumes
DisassociateElasticIP
RegisterEcsCluster
StopInstance
RegisterVolume
SetTimeBasedAutoScaling
DeregisterElasticIP
AttachElasticLoadBalancer
DescribeUserProfiles
DescribeStackSummary
DeregisterEcsCluster
DescribeApps
UpdateMyUserProfile
DescribeInstances
DescribeDeployments
CreateStack
GrantAccess
DescribeElasticIPs
DeleteLayer
UpdateLayer
CloneStack
GetHostnameSuggestion
CreateApp
DescribePermissions
UpdateElasticIP
DescribeLoadBasedAutoScaling
RegisterInstance
AssociateElasticIP
DetachElasticLoadBalancer
DescribeStackProvisioningParameters
DescribeMyUserProfile
UnassignInstance
RegisterRDSDBInstance
DeleteUserProfile
UpdateUserProfile
DescribeServiceErrors
StartStack
CreateUserProfile
DescribeCommands
DescribeEcsClusters
DescribeElasticLoadBalancers
DeregisterInstance
DescribeRAIdArrays
SetPermission
UpdateVolume
AssignVolume
StartInstance
Types
AppAttributesKeys
data AppAttributesKeys Source
AppType
Architecture
data Architecture Source
AutoScalingType
data AutoScalingType Source
DeploymentCommandName
data DeploymentCommandName Source
Configure | |
Deploy | |
ExecuteRecipes | |
InstallDependencies | |
Restart | |
Rollback | |
Setup | |
Start | |
Stop | |
Undeploy | |
UpdateCustomCookbooks | |
UpdateDependencies |
LayerAttributesKeys
data LayerAttributesKeys Source
LayerType
RootDeviceType
data RootDeviceType Source
SourceType
data SourceType Source
StackAttributesKeys
data StackAttributesKeys Source
VirtualizationType
data VirtualizationType Source
VolumeType
data VolumeType Source
AgentVersion
data AgentVersion Source
Describes an agent version.
See: agentVersion
smart constructor.
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:
avConfigurationManager :: Lens' AgentVersion (Maybe StackConfigurationManager) Source
The configuration manager.
App
A description of the app.
See: app
smart constructor.
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 :: 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.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 10KB)" message.
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 starts or stops load-based instances.
See: autoScalingThresholds
smart constructor.
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 :: 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 should ignore metrics and suppress additional scaling events.
For example, AWS OpsWorks 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 to
suppress scaling events long enough to get the new instances online.
astLoadThreshold :: Lens' AutoScalingThresholds (Maybe Double) Source
The load 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.
To use custom alarms, you must update your service role to allow 'cloudwatch:DescribeAlarms'. You can either have AWS OpsWorks update the role for you when you first use this feature or you can edit the role manually. For more information, see Allowing AWS OpsWorks to Act on Your Behalf.
astMemoryThreshold :: Lens' AutoScalingThresholds (Maybe Double) Source
The memory utilization threshold, as a percent of the available memory.
astCPUThreshold :: Lens' AutoScalingThresholds (Maybe Double) Source
The CPU utilization threshold, as a percent of the available CPU.
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.
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 :: 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 '\/dev\/sdh'.
For the root device, you can use the explicit device name or you can set
this parameter to ROOT_DEVICE
and AWS OpsWorks will provide the
correct device name.
ChefConfiguration
data ChefConfiguration Source
Describes the Chef configuration.
See: chefConfiguration
smart constructor.
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 :: Lens' ChefConfiguration (Maybe Text) Source
The Berkshelf version.
ccManageBerkshelf :: Lens' ChefConfiguration (Maybe Bool) Source
Whether to enable Berkshelf.
Command
Describes a command.
See: command
smart constructor.
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:
cInstanceId :: Lens' Command (Maybe Text) Source
The ID of the instance where the command was executed.
cType :: Lens' Command (Maybe Text) Source
The command type:
deploy
rollback
start
stop
restart
undeploy
update_dependencies
install_dependencies
update_custom_cookbooks
execute_recipes
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.
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:
dsDatabaseName :: Lens' DataSource (Maybe Text) Source
The database name.
dsType :: Lens' DataSource (Maybe Text) Source
The data source's type, AutoSelectOpsworksMysqlInstance
,
OpsworksMysqlInstance
, or RdsDbInstance
.
Deployment
data Deployment Source
Describes a deployment of a stack or app.
See: deployment
smart constructor.
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 :: Lens' Deployment (Maybe Text) Source
The deployment ID.
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 and must escape characters such as '"':
'"{\"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.
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 :: 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 2014.09'. You must also set theallow_reboot
argument to true.allow_reboot
- Specifies whether to allow AWS OpsWorks to reboot the instances if necessary, after installing the updates. This argument can be set to eithertrue
orfalse
. The default value isfalse
.
For example, to upgrade an instance to Amazon Linux 2014.09, set Args
to the following.
' { "upgrade_os_to":["Amazon Linux 2014.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 anArgs
parameter namedrecipes
to the list of recipes to be executed. For example, to execute 'phpapp::appsetup', setArgs
to '{"recipes":["phpapp::appsetup"]}'.install_dependencies
: Install the stack's dependencies.update_custom_cookbooks
: Update the stack's custom cookbooks.update_dependencies
: Update the stack's dependencies.
The update_dependencies and install_dependencies commands are supported only for Linux instances. You can run the commands successfully on Windows instances, but they do nothing.
For apps, the following commands are available:
deploy
: Deploy an app. Ruby on Rails apps have an optionalArgs
parameter namedmigrate
. SetArgs
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 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.
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 :: 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 I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
ebdVolumeType :: Lens' EBSBlockDevice (Maybe VolumeType) Source
The volume type. gp2
for General Purpose (SSD) volumes, io1
for
Provisioned IOPS (SSD) volumes, and standard
for Magnetic volumes.
ebdSnapshotId :: Lens' EBSBlockDevice (Maybe Text) Source
The snapshot ID.
EcsCluster
data EcsCluster Source
Describes a registered Amazon ECS cluster.
See: ecsCluster
smart constructor.
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 :: 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.
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.
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 :: 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.
elbEC2InstanceIds :: Lens' ElasticLoadBalancer [Text] Source
A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
elbStackId :: Lens' ElasticLoadBalancer (Maybe Text) Source
The ID of the stack that the instance is associated with.
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.
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 :: 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.
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:
iInstanceId
iPrivateIP
iInstallUpdatesOnBoot
iReportedAgentVersion
iStatus
iPrivateDNS
iVirtualizationType
iSecurityGroupIds
iSSHHostRsaKeyFingerprint
iInstanceProfileARN
iPlatform
iHostname
iEcsClusterARN
iCreatedAt
iSSHKeyName
iEC2InstanceId
iAgentVersion
iRootDeviceVolumeId
iSubnetId
iInstanceType
iInfrastructureClass
iEBSOptimized
iSSHHostDsaKeyFingerprint
iElasticIP
iOS
iAvailabilityZone
iLastServiceErrorId
iAutoScalingType
iLayerIds
iArchitecture
iPublicDNS
iPublicIP
iAMIId
iReportedOS
iStackId
iRegisteredBy
iBlockDeviceMappings
iEcsContainerInstanceARN
iRootDeviceType
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.
We strongly recommend using the default value of true
, to ensure that
your instances have the latest security updates.
iReportedAgentVersion :: Lens' Instance (Maybe Text) Source
The instance's reported AWS OpsWorks 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
stopped
stopping
terminated
terminating
iVirtualizationType :: Lens' Instance (Maybe VirtualizationType) Source
The instance's virtualization type: paravirtual
or hvm
.
iSecurityGroupIds :: Lens' Instance [Text] Source
An array containing the instance security group IDs.
iInstanceProfileARN :: Lens' Instance (Maybe Text) Source
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
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'.
iEBSOptimized :: Lens' Instance (Maybe Bool) Source
Whether this is an Amazon EBS-optimized instance.
iSSHHostDsaKeyFingerprint :: Lens' Instance (Maybe Text) Source
The SSH key's Deep Security Agent (DSA) fingerprint.
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.
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.
iBlockDeviceMappings :: Lens' Instance [BlockDeviceMapping] Source
An array of BlockDeviceMapping
objects that specify the instance's
block device mappings.
iEcsContainerInstanceARN :: Lens' Instance (Maybe Text) Source
For container instances, the instance's ARN.
iRootDeviceType :: Lens' Instance (Maybe RootDeviceType) Source
The instance's root device type. For more information, see Storage for the Root Device.
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.
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 :: 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.
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 :: 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.
icRequested :: Lens' InstancesCount (Maybe Int) Source
The number of instances with requested
status.
icRunningSetup :: Lens' InstancesCount (Maybe Int) Source
The number of instances with running_setup
status.
icDeregistering :: Lens' InstancesCount (Maybe Int) Source
The number of instances in the Deregistering state.
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.
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
lInstallUpdatesOnBoot
lCustomSecurityGroupIds
lLifecycleEventConfiguration
lShortname
lCreatedAt
lDefaultRecipes
lCustomRecipes
lVolumeConfigurations
lCustomJSON
lEnableAutoHealing
lPackages
lName
lAttributes
lAutoAssignPublicIPs
lUseEBSOptimizedInstances
lType
lStackId
lLayerId
lDefaultSecurityGroupNames
lAutoAssignElasticIPs
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.
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.
We strongly recommend using the default value of true
, to ensure that
your instances have the latest security updates.
lCustomSecurityGroupIds :: Lens' Layer [Text] Source
An array containing the layer's custom security group IDs.
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.
lVolumeConfigurations :: Lens' Layer [VolumeConfiguration] Source
A VolumeConfigurations
object that describes the layer's Amazon EBS
volumes.
lCustomJSON :: Lens' Layer (Maybe Text) Source
A JSON formatted string containing the layer's custom stack configuration and deployment attributes.
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 Text) Source
The layer attributes.
For the HaproxyStatsPassword
, MysqlRootPassword
, and
GangliaPassword
attributes, AWS OpsWorks returns '*****FILTERED*****'
instead of the actual value
For an ECS Cluster layer, AWS OpsWorks 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.
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 :: 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.
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 :: Lens' LoadBasedAutoScalingConfiguration (Maybe AutoScalingThresholds) Source
An AutoScalingThresholds
object that describes the upscaling
configuration, which defines how and when AWS OpsWorks 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 reduces the
number of instances.
lbascLayerId :: Lens' LoadBasedAutoScalingConfiguration (Maybe Text) Source
The layer ID.
Permission
data Permission Source
Describes stack or user permissions.
See: permission
smart constructor.
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 :: 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.
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:
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.
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 :: Lens' RDSDBInstance (Maybe Text) Source
The instance's ARN.
rdiMissingOnRDS :: Lens' RDSDBInstance (Maybe Bool) Source
Set to true
if AWS OpsWorks was unable to discover the Amazon RDS
instance. AWS OpsWorks 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 that the instance is registered with.
rdiDBPassword :: Lens' RDSDBInstance (Maybe Text) Source
AWS OpsWorks returns '*****FILTERED*****' instead of the actual value.
Recipes
AWS OpsWorks supports five lifecycle events: setup,
configuration, deploy, undeploy, and shutdown. For each
layer, AWS OpsWorks 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 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.
rSetup :: Lens' Recipes [Text] Source
An array of custom recipe names to be run following a setup
event.
rUndeploy :: Lens' Recipes [Text] Source
An array of custom recipe names to be run following a undeploy
event.
rShutdown :: Lens' Recipes [Text] Source
An array of custom recipe names to be run following a shutdown
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.
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.
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:
scChain :: Lens' SSLConfiguration (Maybe Text) Source
Optional. Can be used to specify an intermediate certificate authority key or client authentication.
scCertificate :: Lens' SSLConfiguration Text Source
The contents of the certificate's domain.crt file.
scPrivateKey :: Lens' SSLConfiguration Text Source
The private key; the contents of the certificate's domain.kex file.
SelfUserProfile
data SelfUserProfile Source
Describes a user's SSH information.
See: selfUserProfile
smart constructor.
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:
supSSHUsername :: Lens' SelfUserProfile (Maybe Text) Source
The user's SSH user name.
supSSHPublicKey :: Lens' SelfUserProfile (Maybe Text) Source
The user's SSH public key.
supIAMUserARN :: Lens' SelfUserProfile (Maybe Text) Source
The user's IAM ARN.
ServiceError'
data ServiceError' Source
Describes an AWS OpsWorks service error.
See: serviceError'
smart constructor.
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 :: 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.
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 :: Lens' ShutdownEventConfiguration (Maybe Int) Source
The time, in seconds, that AWS OpsWorks 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.
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 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 returns '*****FILTERED*****' instead of the actual value.
sRevision :: Lens' Source (Maybe Text) Source
The application's version. AWS OpsWorks 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.
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
sServiceRoleARN
sARN
sDefaultRootDeviceType
sCreatedAt
sChefConfiguration
sVPCId
sAgentVersion
sDefaultSSHKeyName
sCustomJSON
sCustomCookbooksSource
sDefaultAvailabilityZone
sName
sUseOpsworksSecurityGroups
sDefaultOS
sAttributes
sUseCustomCookbooks
sDefaultSubnetId
sRegion
sConfigurationManager
sStackId
sHostnameTheme
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.
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.
sVPCId :: Lens' Stack (Maybe Text) Source
The VPC ID; applicable only if the stack is running in a VPC.
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 and must escape characters such as '"':
'"{\"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.
sUseOpsworksSecurityGroups :: Lens' Stack (Maybe Bool) Source
Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
sAttributes :: Lens' Stack (HashMap StackAttributesKeys Text) Source
The stack's attributes.
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 "us-east-1". 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.
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 :: 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 0.9, 11.4, or 11.10. The default value is 11.4.
StackSummary
data StackSummary Source
Summarizes the number of layers, instances, and apps in a stack.
See: stackSummary
smart constructor.
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:
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.
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 :: Lens' TemporaryCredential (Maybe Text) Source
The instance's AWS OpsWorks 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.
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 :: 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.
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:
upSSHUsername :: Lens' UserProfile (Maybe Text) Source
The user's SSH user name.
upSSHPublicKey :: Lens' UserProfile (Maybe Text) Source
The user's SSH public key.
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.
upIAMUserARN :: Lens' UserProfile (Maybe Text) Source
The user's IAM ARN.
Volume
Describes an instance's Amazon EBS volume.
See: volume
smart constructor.
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:
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.
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:
vcRAIdLevel :: Lens' VolumeConfiguration (Maybe Int) Source
The volume RAID level.
vcVolumeType :: Lens' VolumeConfiguration (Maybe Text) Source
The volume type:
standard
- Magneticio1
- Provisioned IOPS (SSD)gp2
- General Purpose (SSD)
vcMountPoint :: Lens' VolumeConfiguration Text Source
The volume mount point. For example "/dev/sdh".
vcNumberOfDisks :: Lens' VolumeConfiguration Int Source
The number of disks in the volume.
vcSize :: Lens' VolumeConfiguration Int Source
The volume size.
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.
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 :: 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.