Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
Amazonka.OpsWorks
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- AssignInstance
- AssignVolume
- AssociateElasticIp
- AttachElasticLoadBalancer
- CloneStack
- CreateApp
- CreateDeployment
- CreateInstance
- CreateLayer
- CreateStack
- CreateUserProfile
- DeleteApp
- DeleteInstance
- DeleteLayer
- DeleteStack
- DeleteUserProfile
- DeregisterEcsCluster
- DeregisterElasticIp
- DeregisterInstance
- DeregisterRdsDbInstance
- DeregisterVolume
- DescribeAgentVersions
- DescribeApps
- DescribeCommands
- DescribeDeployments
- DescribeEcsClusters (Paginated)
- DescribeElasticIps
- DescribeElasticLoadBalancers
- DescribeInstances
- DescribeLayers
- DescribeLoadBasedAutoScaling
- DescribeMyUserProfile
- DescribeOperatingSystems
- DescribePermissions
- DescribeRaidArrays
- DescribeRdsDbInstances
- DescribeServiceErrors
- DescribeStackProvisioningParameters
- DescribeStackSummary
- DescribeStacks
- DescribeTimeBasedAutoScaling
- DescribeUserProfiles
- DescribeVolumes
- DetachElasticLoadBalancer
- DisassociateElasticIp
- GetHostnameSuggestion
- GrantAccess
- ListTags
- RebootInstance
- RegisterEcsCluster
- RegisterElasticIp
- RegisterInstance
- RegisterRdsDbInstance
- RegisterVolume
- SetLoadBasedAutoScaling
- SetPermission
- SetTimeBasedAutoScaling
- StartInstance
- StartStack
- StopInstance
- StopStack
- TagResource
- UnassignInstance
- UnassignVolume
- UntagResource
- UpdateApp
- UpdateElasticIp
- UpdateInstance
- UpdateLayer
- UpdateMyUserProfile
- UpdateRdsDbInstance
- UpdateStack
- UpdateUserProfile
- UpdateVolume
- 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
- SelfUserProfile
- ServiceError
- ShutdownEventConfiguration
- Source
- SslConfiguration
- Stack
- StackConfigurationManager
- StackSummary
- TemporaryCredential
- TimeBasedAutoScalingConfiguration
- UserProfile
- Volume
- VolumeConfiguration
- WeeklyAutoScalingSchedule
Description
Derived from API version 2013-02-18
of the AWS service descriptions, licensed under Apache 2.0.
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.
You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.
Synopsis
- defaultService :: Service
- _ResourceNotFoundException :: AsError a => Fold a ServiceError
- _ValidationException :: AsError a => Fold a ServiceError
- newAppExists :: Wait DescribeApps
- newDeploymentSuccessful :: Wait DescribeDeployments
- newInstanceOnline :: Wait DescribeInstances
- newInstanceRegistered :: Wait DescribeInstances
- newInstanceStopped :: Wait DescribeInstances
- newInstanceTerminated :: Wait DescribeInstances
- data AssignInstance = AssignInstance' Text [Text]
- newAssignInstance :: Text -> AssignInstance
- data AssignInstanceResponse = AssignInstanceResponse' {
- newAssignInstanceResponse :: AssignInstanceResponse
- data AssignVolume = AssignVolume' (Maybe Text) Text
- newAssignVolume :: Text -> AssignVolume
- data AssignVolumeResponse = AssignVolumeResponse' {
- newAssignVolumeResponse :: AssignVolumeResponse
- data AssociateElasticIp = AssociateElasticIp' (Maybe Text) Text
- newAssociateElasticIp :: Text -> AssociateElasticIp
- data AssociateElasticIpResponse = AssociateElasticIpResponse' {
- newAssociateElasticIpResponse :: AssociateElasticIpResponse
- data AttachElasticLoadBalancer = AttachElasticLoadBalancer' Text Text
- newAttachElasticLoadBalancer :: Text -> Text -> AttachElasticLoadBalancer
- data AttachElasticLoadBalancerResponse = AttachElasticLoadBalancerResponse' {
- newAttachElasticLoadBalancerResponse :: AttachElasticLoadBalancerResponse
- data CloneStack = CloneStack' (Maybe Text) (Maybe (HashMap StackAttributesKeys (Maybe Text))) (Maybe ChefConfiguration) (Maybe [Text]) (Maybe Bool) (Maybe StackConfigurationManager) (Maybe Source) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) Text Text
- newCloneStack :: Text -> Text -> CloneStack
- data CloneStackResponse = CloneStackResponse' (Maybe Text) Int
- newCloneStackResponse :: Int -> CloneStackResponse
- data CreateApp = CreateApp' (Maybe Source) (Maybe (HashMap AppAttributesKeys Text)) (Maybe [DataSource]) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [EnvironmentVariable]) (Maybe Text) (Maybe SslConfiguration) Text Text AppType
- newCreateApp :: Text -> Text -> AppType -> CreateApp
- data CreateAppResponse = CreateAppResponse' (Maybe Text) Int
- newCreateAppResponse :: Int -> CreateAppResponse
- data CreateDeployment = CreateDeployment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) Text DeploymentCommand
- newCreateDeployment :: Text -> DeploymentCommand -> CreateDeployment
- data CreateDeploymentResponse = CreateDeploymentResponse' (Maybe Text) Int
- newCreateDeploymentResponse :: Int -> CreateDeploymentResponse
- data CreateInstance = CreateInstance' (Maybe Text) (Maybe Text) (Maybe Architecture) (Maybe AutoScalingType) (Maybe Text) (Maybe [BlockDeviceMapping]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text [Text] Text
- newCreateInstance :: Text -> Text -> CreateInstance
- data CreateInstanceResponse = CreateInstanceResponse' (Maybe Text) Int
- newCreateInstanceResponse :: Int -> CreateInstanceResponse
- data CreateLayer = CreateLayer' (Maybe (HashMap LayerAttributesKeys (Maybe Text))) (Maybe Bool) (Maybe Bool) (Maybe CloudWatchLogsConfiguration) (Maybe Text) (Maybe Text) (Maybe Recipes) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe LifecycleEventConfiguration) (Maybe [Text]) (Maybe Bool) (Maybe [VolumeConfiguration]) Text LayerType Text Text
- newCreateLayer :: Text -> LayerType -> Text -> Text -> CreateLayer
- data CreateLayerResponse = CreateLayerResponse' (Maybe Text) Int
- newCreateLayerResponse :: Int -> CreateLayerResponse
- data CreateStack = CreateStack' (Maybe Text) (Maybe (HashMap StackAttributesKeys (Maybe Text))) (Maybe ChefConfiguration) (Maybe StackConfigurationManager) (Maybe Source) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) Text Text Text Text
- newCreateStack :: Text -> Text -> Text -> Text -> CreateStack
- data CreateStackResponse = CreateStackResponse' (Maybe Text) Int
- newCreateStackResponse :: Int -> CreateStackResponse
- data CreateUserProfile = CreateUserProfile' (Maybe Bool) (Maybe Text) (Maybe Text) Text
- newCreateUserProfile :: Text -> CreateUserProfile
- data CreateUserProfileResponse = CreateUserProfileResponse' (Maybe Text) Int
- newCreateUserProfileResponse :: Int -> CreateUserProfileResponse
- data DeleteApp = DeleteApp' Text
- newDeleteApp :: Text -> DeleteApp
- data DeleteAppResponse = DeleteAppResponse' {
- newDeleteAppResponse :: DeleteAppResponse
- data DeleteInstance = DeleteInstance' (Maybe Bool) (Maybe Bool) Text
- newDeleteInstance :: Text -> DeleteInstance
- data DeleteInstanceResponse = DeleteInstanceResponse' {
- newDeleteInstanceResponse :: DeleteInstanceResponse
- data DeleteLayer = DeleteLayer' Text
- newDeleteLayer :: Text -> DeleteLayer
- data DeleteLayerResponse = DeleteLayerResponse' {
- newDeleteLayerResponse :: DeleteLayerResponse
- data DeleteStack = DeleteStack' Text
- newDeleteStack :: Text -> DeleteStack
- data DeleteStackResponse = DeleteStackResponse' {
- newDeleteStackResponse :: DeleteStackResponse
- data DeleteUserProfile = DeleteUserProfile' Text
- newDeleteUserProfile :: Text -> DeleteUserProfile
- data DeleteUserProfileResponse = DeleteUserProfileResponse' {
- newDeleteUserProfileResponse :: DeleteUserProfileResponse
- data DeregisterEcsCluster = DeregisterEcsCluster' Text
- newDeregisterEcsCluster :: Text -> DeregisterEcsCluster
- data DeregisterEcsClusterResponse = DeregisterEcsClusterResponse' {
- newDeregisterEcsClusterResponse :: DeregisterEcsClusterResponse
- data DeregisterElasticIp = DeregisterElasticIp' Text
- newDeregisterElasticIp :: Text -> DeregisterElasticIp
- data DeregisterElasticIpResponse = DeregisterElasticIpResponse' {
- newDeregisterElasticIpResponse :: DeregisterElasticIpResponse
- data DeregisterInstance = DeregisterInstance' Text
- newDeregisterInstance :: Text -> DeregisterInstance
- data DeregisterInstanceResponse = DeregisterInstanceResponse' {
- newDeregisterInstanceResponse :: DeregisterInstanceResponse
- data DeregisterRdsDbInstance = DeregisterRdsDbInstance' Text
- newDeregisterRdsDbInstance :: Text -> DeregisterRdsDbInstance
- data DeregisterRdsDbInstanceResponse = DeregisterRdsDbInstanceResponse' {
- newDeregisterRdsDbInstanceResponse :: DeregisterRdsDbInstanceResponse
- data DeregisterVolume = DeregisterVolume' Text
- newDeregisterVolume :: Text -> DeregisterVolume
- data DeregisterVolumeResponse = DeregisterVolumeResponse' {
- newDeregisterVolumeResponse :: DeregisterVolumeResponse
- data DescribeAgentVersions = DescribeAgentVersions' (Maybe StackConfigurationManager) (Maybe Text)
- newDescribeAgentVersions :: DescribeAgentVersions
- data DescribeAgentVersionsResponse = DescribeAgentVersionsResponse' (Maybe [AgentVersion]) Int
- newDescribeAgentVersionsResponse :: Int -> DescribeAgentVersionsResponse
- data DescribeApps = DescribeApps' (Maybe [Text]) (Maybe Text)
- newDescribeApps :: DescribeApps
- data DescribeAppsResponse = DescribeAppsResponse' (Maybe [App]) Int
- newDescribeAppsResponse :: Int -> DescribeAppsResponse
- data DescribeCommands = DescribeCommands' (Maybe [Text]) (Maybe Text) (Maybe Text)
- newDescribeCommands :: DescribeCommands
- data DescribeCommandsResponse = DescribeCommandsResponse' (Maybe [Command]) Int
- newDescribeCommandsResponse :: Int -> DescribeCommandsResponse
- data DescribeDeployments = DescribeDeployments' (Maybe Text) (Maybe [Text]) (Maybe Text)
- newDescribeDeployments :: DescribeDeployments
- data DescribeDeploymentsResponse = DescribeDeploymentsResponse' (Maybe [Deployment]) Int
- newDescribeDeploymentsResponse :: Int -> DescribeDeploymentsResponse
- data DescribeEcsClusters = DescribeEcsClusters' (Maybe [Text]) (Maybe Int) (Maybe Text) (Maybe Text)
- newDescribeEcsClusters :: DescribeEcsClusters
- data DescribeEcsClustersResponse = DescribeEcsClustersResponse' (Maybe [EcsCluster]) (Maybe Text) Int
- newDescribeEcsClustersResponse :: Int -> DescribeEcsClustersResponse
- data DescribeElasticIps = DescribeElasticIps' (Maybe Text) (Maybe [Text]) (Maybe Text)
- newDescribeElasticIps :: DescribeElasticIps
- data DescribeElasticIpsResponse = DescribeElasticIpsResponse' (Maybe [ElasticIp]) Int
- newDescribeElasticIpsResponse :: Int -> DescribeElasticIpsResponse
- data DescribeElasticLoadBalancers = DescribeElasticLoadBalancers' (Maybe [Text]) (Maybe Text)
- newDescribeElasticLoadBalancers :: DescribeElasticLoadBalancers
- data DescribeElasticLoadBalancersResponse = DescribeElasticLoadBalancersResponse' (Maybe [ElasticLoadBalancer]) Int
- newDescribeElasticLoadBalancersResponse :: Int -> DescribeElasticLoadBalancersResponse
- data DescribeInstances = DescribeInstances' (Maybe [Text]) (Maybe Text) (Maybe Text)
- newDescribeInstances :: DescribeInstances
- data DescribeInstancesResponse = DescribeInstancesResponse' (Maybe [Instance]) Int
- newDescribeInstancesResponse :: Int -> DescribeInstancesResponse
- data DescribeLayers = DescribeLayers' (Maybe [Text]) (Maybe Text)
- newDescribeLayers :: DescribeLayers
- data DescribeLayersResponse = DescribeLayersResponse' (Maybe [Layer]) Int
- newDescribeLayersResponse :: Int -> DescribeLayersResponse
- data DescribeLoadBasedAutoScaling = DescribeLoadBasedAutoScaling' [Text]
- newDescribeLoadBasedAutoScaling :: DescribeLoadBasedAutoScaling
- data DescribeLoadBasedAutoScalingResponse = DescribeLoadBasedAutoScalingResponse' (Maybe [LoadBasedAutoScalingConfiguration]) Int
- newDescribeLoadBasedAutoScalingResponse :: Int -> DescribeLoadBasedAutoScalingResponse
- data DescribeMyUserProfile = DescribeMyUserProfile' {
- newDescribeMyUserProfile :: DescribeMyUserProfile
- data DescribeMyUserProfileResponse = DescribeMyUserProfileResponse' (Maybe SelfUserProfile) Int
- newDescribeMyUserProfileResponse :: Int -> DescribeMyUserProfileResponse
- data DescribeOperatingSystems = DescribeOperatingSystems' {
- newDescribeOperatingSystems :: DescribeOperatingSystems
- data DescribeOperatingSystemsResponse = DescribeOperatingSystemsResponse' (Maybe [OperatingSystem]) Int
- newDescribeOperatingSystemsResponse :: Int -> DescribeOperatingSystemsResponse
- data DescribePermissions = DescribePermissions' (Maybe Text) (Maybe Text)
- newDescribePermissions :: DescribePermissions
- data DescribePermissionsResponse = DescribePermissionsResponse' (Maybe [Permission]) Int
- newDescribePermissionsResponse :: Int -> DescribePermissionsResponse
- data DescribeRaidArrays = DescribeRaidArrays' (Maybe Text) (Maybe [Text]) (Maybe Text)
- newDescribeRaidArrays :: DescribeRaidArrays
- data DescribeRaidArraysResponse = DescribeRaidArraysResponse' (Maybe [RaidArray]) Int
- newDescribeRaidArraysResponse :: Int -> DescribeRaidArraysResponse
- data DescribeRdsDbInstances = DescribeRdsDbInstances' (Maybe [Text]) Text
- newDescribeRdsDbInstances :: Text -> DescribeRdsDbInstances
- data DescribeRdsDbInstancesResponse = DescribeRdsDbInstancesResponse' (Maybe [RdsDbInstance]) Int
- newDescribeRdsDbInstancesResponse :: Int -> DescribeRdsDbInstancesResponse
- data DescribeServiceErrors = DescribeServiceErrors' (Maybe Text) (Maybe [Text]) (Maybe Text)
- newDescribeServiceErrors :: DescribeServiceErrors
- data DescribeServiceErrorsResponse = DescribeServiceErrorsResponse' (Maybe [ServiceError]) Int
- newDescribeServiceErrorsResponse :: Int -> DescribeServiceErrorsResponse
- data DescribeStackProvisioningParameters = DescribeStackProvisioningParameters' Text
- newDescribeStackProvisioningParameters :: Text -> DescribeStackProvisioningParameters
- data DescribeStackProvisioningParametersResponse = DescribeStackProvisioningParametersResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int
- newDescribeStackProvisioningParametersResponse :: Int -> DescribeStackProvisioningParametersResponse
- data DescribeStackSummary = DescribeStackSummary' Text
- newDescribeStackSummary :: Text -> DescribeStackSummary
- data DescribeStackSummaryResponse = DescribeStackSummaryResponse' (Maybe StackSummary) Int
- newDescribeStackSummaryResponse :: Int -> DescribeStackSummaryResponse
- data DescribeStacks = DescribeStacks' (Maybe [Text])
- newDescribeStacks :: DescribeStacks
- data DescribeStacksResponse = DescribeStacksResponse' (Maybe [Stack]) Int
- newDescribeStacksResponse :: Int -> DescribeStacksResponse
- data DescribeTimeBasedAutoScaling = DescribeTimeBasedAutoScaling' [Text]
- newDescribeTimeBasedAutoScaling :: DescribeTimeBasedAutoScaling
- data DescribeTimeBasedAutoScalingResponse = DescribeTimeBasedAutoScalingResponse' (Maybe [TimeBasedAutoScalingConfiguration]) Int
- newDescribeTimeBasedAutoScalingResponse :: Int -> DescribeTimeBasedAutoScalingResponse
- data DescribeUserProfiles = DescribeUserProfiles' (Maybe [Text])
- newDescribeUserProfiles :: DescribeUserProfiles
- data DescribeUserProfilesResponse = DescribeUserProfilesResponse' (Maybe [UserProfile]) Int
- newDescribeUserProfilesResponse :: Int -> DescribeUserProfilesResponse
- data DescribeVolumes = DescribeVolumes' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text])
- newDescribeVolumes :: DescribeVolumes
- data DescribeVolumesResponse = DescribeVolumesResponse' (Maybe [Volume]) Int
- newDescribeVolumesResponse :: Int -> DescribeVolumesResponse
- data DetachElasticLoadBalancer = DetachElasticLoadBalancer' Text Text
- newDetachElasticLoadBalancer :: Text -> Text -> DetachElasticLoadBalancer
- data DetachElasticLoadBalancerResponse = DetachElasticLoadBalancerResponse' {
- newDetachElasticLoadBalancerResponse :: DetachElasticLoadBalancerResponse
- data DisassociateElasticIp = DisassociateElasticIp' Text
- newDisassociateElasticIp :: Text -> DisassociateElasticIp
- data DisassociateElasticIpResponse = DisassociateElasticIpResponse' {
- newDisassociateElasticIpResponse :: DisassociateElasticIpResponse
- data GetHostnameSuggestion = GetHostnameSuggestion' Text
- newGetHostnameSuggestion :: Text -> GetHostnameSuggestion
- data GetHostnameSuggestionResponse = GetHostnameSuggestionResponse' (Maybe Text) (Maybe Text) Int
- newGetHostnameSuggestionResponse :: Int -> GetHostnameSuggestionResponse
- data GrantAccess = GrantAccess' (Maybe Natural) Text
- newGrantAccess :: Text -> GrantAccess
- data GrantAccessResponse = GrantAccessResponse' (Maybe TemporaryCredential) Int
- newGrantAccessResponse :: Int -> GrantAccessResponse
- data ListTags = ListTags' (Maybe Int) (Maybe Text) Text
- newListTags :: Text -> ListTags
- data ListTagsResponse = ListTagsResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int
- newListTagsResponse :: Int -> ListTagsResponse
- data RebootInstance = RebootInstance' Text
- newRebootInstance :: Text -> RebootInstance
- data RebootInstanceResponse = RebootInstanceResponse' {
- newRebootInstanceResponse :: RebootInstanceResponse
- data RegisterEcsCluster = RegisterEcsCluster' Text Text
- newRegisterEcsCluster :: Text -> Text -> RegisterEcsCluster
- data RegisterEcsClusterResponse = RegisterEcsClusterResponse' (Maybe Text) Int
- newRegisterEcsClusterResponse :: Int -> RegisterEcsClusterResponse
- data RegisterElasticIp = RegisterElasticIp' Text Text
- newRegisterElasticIp :: Text -> Text -> RegisterElasticIp
- data RegisterElasticIpResponse = RegisterElasticIpResponse' (Maybe Text) Int
- newRegisterElasticIpResponse :: Int -> RegisterElasticIpResponse
- data RegisterInstance = RegisterInstance' (Maybe Text) (Maybe InstanceIdentity) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text
- newRegisterInstance :: Text -> RegisterInstance
- data RegisterInstanceResponse = RegisterInstanceResponse' (Maybe Text) Int
- newRegisterInstanceResponse :: Int -> RegisterInstanceResponse
- data RegisterRdsDbInstance = RegisterRdsDbInstance' Text Text Text Text
- newRegisterRdsDbInstance :: Text -> Text -> Text -> Text -> RegisterRdsDbInstance
- data RegisterRdsDbInstanceResponse = RegisterRdsDbInstanceResponse' {
- newRegisterRdsDbInstanceResponse :: RegisterRdsDbInstanceResponse
- data RegisterVolume = RegisterVolume' (Maybe Text) Text
- newRegisterVolume :: Text -> RegisterVolume
- data RegisterVolumeResponse = RegisterVolumeResponse' (Maybe Text) Int
- newRegisterVolumeResponse :: Int -> RegisterVolumeResponse
- data SetLoadBasedAutoScaling = SetLoadBasedAutoScaling' (Maybe AutoScalingThresholds) (Maybe Bool) (Maybe AutoScalingThresholds) Text
- newSetLoadBasedAutoScaling :: Text -> SetLoadBasedAutoScaling
- data SetLoadBasedAutoScalingResponse = SetLoadBasedAutoScalingResponse' {
- newSetLoadBasedAutoScalingResponse :: SetLoadBasedAutoScalingResponse
- data SetPermission = SetPermission' (Maybe Bool) (Maybe Bool) (Maybe Text) Text Text
- newSetPermission :: Text -> Text -> SetPermission
- data SetPermissionResponse = SetPermissionResponse' {
- newSetPermissionResponse :: SetPermissionResponse
- data SetTimeBasedAutoScaling = SetTimeBasedAutoScaling' (Maybe WeeklyAutoScalingSchedule) Text
- newSetTimeBasedAutoScaling :: Text -> SetTimeBasedAutoScaling
- data SetTimeBasedAutoScalingResponse = SetTimeBasedAutoScalingResponse' {
- newSetTimeBasedAutoScalingResponse :: SetTimeBasedAutoScalingResponse
- data StartInstance = StartInstance' Text
- newStartInstance :: Text -> StartInstance
- data StartInstanceResponse = StartInstanceResponse' {
- newStartInstanceResponse :: StartInstanceResponse
- data StartStack = StartStack' Text
- newStartStack :: Text -> StartStack
- data StartStackResponse = StartStackResponse' {
- newStartStackResponse :: StartStackResponse
- data StopInstance = StopInstance' (Maybe Bool) Text
- newStopInstance :: Text -> StopInstance
- data StopInstanceResponse = StopInstanceResponse' {
- newStopInstanceResponse :: StopInstanceResponse
- data StopStack = StopStack' Text
- newStopStack :: Text -> StopStack
- data StopStackResponse = StopStackResponse' {
- newStopStackResponse :: StopStackResponse
- data TagResource = TagResource' Text (HashMap Text Text)
- newTagResource :: Text -> TagResource
- data TagResourceResponse = TagResourceResponse' {
- newTagResourceResponse :: TagResourceResponse
- data UnassignInstance = UnassignInstance' Text
- newUnassignInstance :: Text -> UnassignInstance
- data UnassignInstanceResponse = UnassignInstanceResponse' {
- newUnassignInstanceResponse :: UnassignInstanceResponse
- data UnassignVolume = UnassignVolume' Text
- newUnassignVolume :: Text -> UnassignVolume
- data UnassignVolumeResponse = UnassignVolumeResponse' {
- newUnassignVolumeResponse :: UnassignVolumeResponse
- data UntagResource = UntagResource' Text [Text]
- newUntagResource :: Text -> UntagResource
- data UntagResourceResponse = UntagResourceResponse' {
- newUntagResourceResponse :: UntagResourceResponse
- data UpdateApp = UpdateApp' (Maybe Source) (Maybe (HashMap AppAttributesKeys Text)) (Maybe [DataSource]) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [EnvironmentVariable]) (Maybe Text) (Maybe SslConfiguration) (Maybe AppType) Text
- newUpdateApp :: Text -> UpdateApp
- data UpdateAppResponse = UpdateAppResponse' {
- newUpdateAppResponse :: UpdateAppResponse
- data UpdateElasticIp = UpdateElasticIp' (Maybe Text) Text
- newUpdateElasticIp :: Text -> UpdateElasticIp
- data UpdateElasticIpResponse = UpdateElasticIpResponse' {
- newUpdateElasticIpResponse :: UpdateElasticIpResponse
- data UpdateInstance = UpdateInstance' (Maybe Text) (Maybe Text) (Maybe Architecture) (Maybe AutoScalingType) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) Text
- newUpdateInstance :: Text -> UpdateInstance
- data UpdateInstanceResponse = UpdateInstanceResponse' {
- newUpdateInstanceResponse :: UpdateInstanceResponse
- data UpdateLayer = UpdateLayer' (Maybe (HashMap LayerAttributesKeys (Maybe Text))) (Maybe Bool) (Maybe Bool) (Maybe CloudWatchLogsConfiguration) (Maybe Text) (Maybe Text) (Maybe Recipes) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe LifecycleEventConfiguration) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe [VolumeConfiguration]) Text
- newUpdateLayer :: Text -> UpdateLayer
- data UpdateLayerResponse = UpdateLayerResponse' {
- newUpdateLayerResponse :: UpdateLayerResponse
- data UpdateMyUserProfile = UpdateMyUserProfile' (Maybe Text)
- newUpdateMyUserProfile :: UpdateMyUserProfile
- data UpdateMyUserProfileResponse = UpdateMyUserProfileResponse' {
- newUpdateMyUserProfileResponse :: UpdateMyUserProfileResponse
- data UpdateRdsDbInstance = UpdateRdsDbInstance' (Maybe Text) (Maybe Text) Text
- newUpdateRdsDbInstance :: Text -> UpdateRdsDbInstance
- data UpdateRdsDbInstanceResponse = UpdateRdsDbInstanceResponse' {
- newUpdateRdsDbInstanceResponse :: UpdateRdsDbInstanceResponse
- data UpdateStack = UpdateStack' (Maybe Text) (Maybe (HashMap StackAttributesKeys (Maybe Text))) (Maybe ChefConfiguration) (Maybe StackConfigurationManager) (Maybe Source) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) Text
- newUpdateStack :: Text -> UpdateStack
- data UpdateStackResponse = UpdateStackResponse' {
- newUpdateStackResponse :: UpdateStackResponse
- data UpdateUserProfile = UpdateUserProfile' (Maybe Bool) (Maybe Text) (Maybe Text) Text
- newUpdateUserProfile :: Text -> UpdateUserProfile
- data UpdateUserProfileResponse = UpdateUserProfileResponse' {
- newUpdateUserProfileResponse :: UpdateUserProfileResponse
- data UpdateVolume = UpdateVolume' (Maybe Text) (Maybe Text) Text
- newUpdateVolume :: Text -> UpdateVolume
- data UpdateVolumeResponse = UpdateVolumeResponse' {
- newUpdateVolumeResponse :: UpdateVolumeResponse
- newtype AppAttributesKeys where
- newtype AppType where
- AppType' {
- fromAppType :: Text
- pattern AppType_Aws_flow_ruby :: AppType
- pattern AppType_Java :: AppType
- pattern AppType_Nodejs :: AppType
- pattern AppType_Other :: AppType
- pattern AppType_Php :: AppType
- pattern AppType_Rails :: AppType
- pattern AppType_Static :: AppType
- AppType' {
- newtype Architecture where
- Architecture' { }
- pattern Architecture_I386 :: Architecture
- pattern Architecture_X86_64 :: Architecture
- newtype AutoScalingType where
- AutoScalingType' { }
- pattern AutoScalingType_Load :: AutoScalingType
- pattern AutoScalingType_Timer :: AutoScalingType
- newtype CloudWatchLogsEncoding where
- CloudWatchLogsEncoding' { }
- pattern CloudWatchLogsEncoding_Ascii :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Big5 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Big5hkscs :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp037 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1006 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1026 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1140 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1250 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1251 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1252 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1253 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1254 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1255 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1256 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1257 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp1258 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp424 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp437 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp500 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp720 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp737 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp775 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp850 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp852 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp855 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp856 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp857 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp858 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp860 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp861 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp862 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp863 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp864 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp865 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp866 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp869 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp874 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp875 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp932 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp949 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Cp950 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Euc_jis_2004 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Euc_jisx0213 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Euc_jp :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Euc_kr :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Gb18030 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Gb2312 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Gbk :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Hz :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso2022_jp :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso2022_jp_1 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso2022_jp_2 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso2022_jp_2004 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso2022_jp_3 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso2022_jp_ext :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso2022_kr :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_10 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_13 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_14 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_15 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_16 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_2 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_3 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_4 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_5 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_6 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_7 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_8 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Iso8859_9 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Johab :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Koi8_r :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Koi8_u :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Latin_1 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Mac_cyrillic :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Mac_greek :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Mac_iceland :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Mac_latin2 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Mac_roman :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Mac_turkish :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Ptcp154 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Shift_jis :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Shift_jis_2004 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Shift_jisx0213 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_16 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_16_be :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_16_le :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_32 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_32_be :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_32_le :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_7 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_8 :: CloudWatchLogsEncoding
- pattern CloudWatchLogsEncoding_Utf_8_sig :: CloudWatchLogsEncoding
- newtype CloudWatchLogsInitialPosition where
- newtype CloudWatchLogsTimeZone where
- newtype DeploymentCommandName where
- DeploymentCommandName' { }
- pattern DeploymentCommandName_Configure :: DeploymentCommandName
- pattern DeploymentCommandName_Deploy :: DeploymentCommandName
- pattern DeploymentCommandName_Execute_recipes :: DeploymentCommandName
- pattern DeploymentCommandName_Install_dependencies :: DeploymentCommandName
- pattern DeploymentCommandName_Restart :: DeploymentCommandName
- pattern DeploymentCommandName_Rollback :: DeploymentCommandName
- pattern DeploymentCommandName_Setup :: DeploymentCommandName
- pattern DeploymentCommandName_Start :: DeploymentCommandName
- pattern DeploymentCommandName_Stop :: DeploymentCommandName
- pattern DeploymentCommandName_Undeploy :: DeploymentCommandName
- pattern DeploymentCommandName_Update_custom_cookbooks :: DeploymentCommandName
- pattern DeploymentCommandName_Update_dependencies :: DeploymentCommandName
- newtype LayerAttributesKeys where
- LayerAttributesKeys' { }
- pattern LayerAttributesKeys_BundlerVersion :: LayerAttributesKeys
- pattern LayerAttributesKeys_EcsClusterArn :: LayerAttributesKeys
- pattern LayerAttributesKeys_EnableHaproxyStats :: LayerAttributesKeys
- pattern LayerAttributesKeys_GangliaPassword :: LayerAttributesKeys
- pattern LayerAttributesKeys_GangliaUrl :: LayerAttributesKeys
- pattern LayerAttributesKeys_GangliaUser :: LayerAttributesKeys
- pattern LayerAttributesKeys_HaproxyHealthCheckMethod :: LayerAttributesKeys
- pattern LayerAttributesKeys_HaproxyHealthCheckUrl :: LayerAttributesKeys
- pattern LayerAttributesKeys_HaproxyStatsPassword :: LayerAttributesKeys
- pattern LayerAttributesKeys_HaproxyStatsUrl :: LayerAttributesKeys
- pattern LayerAttributesKeys_HaproxyStatsUser :: LayerAttributesKeys
- pattern LayerAttributesKeys_JavaAppServer :: LayerAttributesKeys
- pattern LayerAttributesKeys_JavaAppServerVersion :: LayerAttributesKeys
- pattern LayerAttributesKeys_Jvm :: LayerAttributesKeys
- pattern LayerAttributesKeys_JvmOptions :: LayerAttributesKeys
- pattern LayerAttributesKeys_JvmVersion :: LayerAttributesKeys
- pattern LayerAttributesKeys_ManageBundler :: LayerAttributesKeys
- pattern LayerAttributesKeys_MemcachedMemory :: LayerAttributesKeys
- pattern LayerAttributesKeys_MysqlRootPassword :: LayerAttributesKeys
- pattern LayerAttributesKeys_MysqlRootPasswordUbiquitous :: LayerAttributesKeys
- pattern LayerAttributesKeys_NodejsVersion :: LayerAttributesKeys
- pattern LayerAttributesKeys_PassengerVersion :: LayerAttributesKeys
- pattern LayerAttributesKeys_RailsStack :: LayerAttributesKeys
- pattern LayerAttributesKeys_RubyVersion :: LayerAttributesKeys
- pattern LayerAttributesKeys_RubygemsVersion :: LayerAttributesKeys
- newtype LayerType where
- LayerType' { }
- pattern LayerType_Aws_flow_ruby :: LayerType
- pattern LayerType_Custom :: LayerType
- pattern LayerType_Db_master :: LayerType
- pattern LayerType_Ecs_cluster :: LayerType
- pattern LayerType_Java_app :: LayerType
- pattern LayerType_Lb :: LayerType
- pattern LayerType_Memcached :: LayerType
- pattern LayerType_Monitoring_master :: LayerType
- pattern LayerType_Nodejs_app :: LayerType
- pattern LayerType_Php_app :: LayerType
- pattern LayerType_Rails_app :: LayerType
- pattern LayerType_Web :: LayerType
- newtype RootDeviceType where
- RootDeviceType' { }
- pattern RootDeviceType_Ebs :: RootDeviceType
- pattern RootDeviceType_Instance_store :: RootDeviceType
- newtype SourceType where
- SourceType' { }
- pattern SourceType_Archive :: SourceType
- pattern SourceType_Git :: SourceType
- pattern SourceType_S3 :: SourceType
- pattern SourceType_Svn :: SourceType
- newtype StackAttributesKeys where
- newtype VirtualizationType where
- newtype VolumeType where
- VolumeType' { }
- pattern VolumeType_Gp2 :: VolumeType
- pattern VolumeType_Io1 :: VolumeType
- pattern VolumeType_Standard :: VolumeType
- data AgentVersion = AgentVersion' (Maybe StackConfigurationManager) (Maybe Text)
- newAgentVersion :: AgentVersion
- data App = App' (Maybe Text) (Maybe Source) (Maybe (HashMap AppAttributesKeys Text)) (Maybe Text) (Maybe [DataSource]) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [EnvironmentVariable]) (Maybe Text) (Maybe Text) (Maybe SslConfiguration) (Maybe Text) (Maybe AppType)
- newApp :: App
- data AutoScalingThresholds = AutoScalingThresholds' (Maybe [Text]) (Maybe Double) (Maybe Natural) (Maybe Int) (Maybe Double) (Maybe Double) (Maybe Natural)
- newAutoScalingThresholds :: AutoScalingThresholds
- data BlockDeviceMapping = BlockDeviceMapping' (Maybe Text) (Maybe EbsBlockDevice) (Maybe Text) (Maybe Text)
- newBlockDeviceMapping :: BlockDeviceMapping
- data ChefConfiguration = ChefConfiguration' (Maybe Text) (Maybe Bool)
- newChefConfiguration :: ChefConfiguration
- data CloudWatchLogsConfiguration = CloudWatchLogsConfiguration' (Maybe Bool) (Maybe [CloudWatchLogsLogStream])
- newCloudWatchLogsConfiguration :: CloudWatchLogsConfiguration
- data CloudWatchLogsLogStream = CloudWatchLogsLogStream' (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe CloudWatchLogsEncoding) (Maybe Text) (Maybe Text) (Maybe CloudWatchLogsInitialPosition) (Maybe Text) (Maybe Text) (Maybe CloudWatchLogsTimeZone)
- newCloudWatchLogsLogStream :: CloudWatchLogsLogStream
- data Command = Command' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newCommand :: Command
- data DataSource = DataSource' (Maybe Text) (Maybe Text) (Maybe Text)
- newDataSource :: DataSource
- data Deployment = Deployment' (Maybe Text) (Maybe DeploymentCommand) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text)
- newDeployment :: Deployment
- data DeploymentCommand = DeploymentCommand' (Maybe (HashMap Text [Text])) DeploymentCommandName
- newDeploymentCommand :: DeploymentCommandName -> DeploymentCommand
- data EbsBlockDevice = EbsBlockDevice' (Maybe Bool) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe VolumeType)
- newEbsBlockDevice :: EbsBlockDevice
- data EcsCluster = EcsCluster' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newEcsCluster :: EcsCluster
- data ElasticIp = ElasticIp' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newElasticIp :: ElasticIp
- data ElasticLoadBalancer = ElasticLoadBalancer' (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text)
- newElasticLoadBalancer :: ElasticLoadBalancer
- data EnvironmentVariable = EnvironmentVariable' (Maybe Bool) Text Text
- newEnvironmentVariable :: Text -> Text -> EnvironmentVariable
- data Instance = Instance' (Maybe Text) (Maybe Text) (Maybe Architecture) (Maybe Text) (Maybe AutoScalingType) (Maybe Text) (Maybe [BlockDeviceMapping]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReportedOs) (Maybe RootDeviceType) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VirtualizationType)
- newInstance :: Instance
- data InstanceIdentity = InstanceIdentity' (Maybe Text) (Maybe Text)
- newInstanceIdentity :: InstanceIdentity
- data InstancesCount = InstancesCount' (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int)
- newInstancesCount :: InstancesCount
- data Layer = Layer' (Maybe Text) (Maybe (HashMap LayerAttributesKeys (Maybe Text))) (Maybe Bool) (Maybe Bool) (Maybe CloudWatchLogsConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Recipes) (Maybe [Text]) (Maybe Recipes) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe LifecycleEventConfiguration) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe LayerType) (Maybe Bool) (Maybe [VolumeConfiguration])
- newLayer :: Layer
- data LifecycleEventConfiguration = LifecycleEventConfiguration' (Maybe ShutdownEventConfiguration)
- newLifecycleEventConfiguration :: LifecycleEventConfiguration
- data LoadBasedAutoScalingConfiguration = LoadBasedAutoScalingConfiguration' (Maybe AutoScalingThresholds) (Maybe Bool) (Maybe Text) (Maybe AutoScalingThresholds)
- newLoadBasedAutoScalingConfiguration :: LoadBasedAutoScalingConfiguration
- data OperatingSystem = OperatingSystem' (Maybe [OperatingSystemConfigurationManager]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text)
- newOperatingSystem :: OperatingSystem
- data OperatingSystemConfigurationManager = OperatingSystemConfigurationManager' (Maybe Text) (Maybe Text)
- newOperatingSystemConfigurationManager :: OperatingSystemConfigurationManager
- data Permission = Permission' (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text)
- newPermission :: Permission
- data RaidArray = RaidArray' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text)
- newRaidArray :: RaidArray
- data RdsDbInstance = RdsDbInstance' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text)
- newRdsDbInstance :: RdsDbInstance
- data Recipes = Recipes' (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text]) (Maybe [Text])
- newRecipes :: Recipes
- data ReportedOs = ReportedOs' (Maybe Text) (Maybe Text) (Maybe Text)
- newReportedOs :: ReportedOs
- data SelfUserProfile = SelfUserProfile' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newSelfUserProfile :: SelfUserProfile
- data ServiceError = ServiceError' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newServiceError :: ServiceError
- data ShutdownEventConfiguration = ShutdownEventConfiguration' (Maybe Bool) (Maybe Int)
- newShutdownEventConfiguration :: ShutdownEventConfiguration
- data Source = Source' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SourceType) (Maybe Text) (Maybe Text)
- newSource :: Source
- data SslConfiguration = SslConfiguration' (Maybe Text) (Maybe Text) (Maybe Text)
- newSslConfiguration :: SslConfiguration
- data Stack = Stack' (Maybe Text) (Maybe Text) (Maybe (HashMap StackAttributesKeys (Maybe Text))) (Maybe ChefConfiguration) (Maybe StackConfigurationManager) (Maybe Text) (Maybe Source) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text)
- newStack :: Stack
- data StackConfigurationManager = StackConfigurationManager' (Maybe Text) (Maybe Text)
- newStackConfigurationManager :: StackConfigurationManager
- data StackSummary = StackSummary' (Maybe Int) (Maybe Text) (Maybe InstancesCount) (Maybe Int) (Maybe Text) (Maybe Text)
- newStackSummary :: StackSummary
- data TemporaryCredential = TemporaryCredential' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int)
- newTemporaryCredential :: TemporaryCredential
- data TimeBasedAutoScalingConfiguration = TimeBasedAutoScalingConfiguration' (Maybe WeeklyAutoScalingSchedule) (Maybe Text)
- newTimeBasedAutoScalingConfiguration :: TimeBasedAutoScalingConfiguration
- data UserProfile = UserProfile' (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text)
- newUserProfile :: UserProfile
- data Volume = Volume' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text)
- newVolume :: Volume
- data VolumeConfiguration = VolumeConfiguration' (Maybe Bool) (Maybe Int) (Maybe Int) (Maybe Text) Text Int Int
- newVolumeConfiguration :: Text -> Int -> Int -> VolumeConfiguration
- data WeeklyAutoScalingSchedule = WeeklyAutoScalingSchedule' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text))
- newWeeklyAutoScalingSchedule :: WeeklyAutoScalingSchedule
Service Configuration
defaultService :: Service Source #
API version 2013-02-18
of the Amazon OpsWorks SDK 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
.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Fold a ServiceError Source #
Indicates that a resource was not found.
ValidationException
_ValidationException :: AsError a => Fold a ServiceError Source #
Indicates that a request was not valid.
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.
AppExists
newAppExists :: Wait DescribeApps Source #
Polls DescribeApps
every 1 seconds until a successful state is reached. An error is returned after 40 failed checks.
DeploymentSuccessful
newDeploymentSuccessful :: Wait DescribeDeployments Source #
Polls DescribeDeployments
every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
InstanceOnline
newInstanceOnline :: Wait DescribeInstances Source #
Polls DescribeInstances
every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
InstanceRegistered
newInstanceRegistered :: Wait DescribeInstances Source #
Polls DescribeInstances
every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
InstanceStopped
newInstanceStopped :: Wait DescribeInstances Source #
Polls DescribeInstances
every 15 seconds until a successful state is reached. An error is returned after 40 failed checks.
InstanceTerminated
newInstanceTerminated :: 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.
AssignInstance
data AssignInstance Source #
See: newAssignInstance
smart constructor.
Constructors
AssignInstance' Text [Text] |
Instances
Arguments
:: Text | |
-> AssignInstance |
Create a value of AssignInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssignInstance
, assignInstance_instanceId
- The instance ID.
AssignInstance
, assignInstance_layerIds
- The layer ID, which must correspond to a custom layer. You cannot assign
a registered instance to a built-in layer.
data AssignInstanceResponse Source #
See: newAssignInstanceResponse
smart constructor.
Constructors
AssignInstanceResponse' | |
Instances
Generic AssignInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.AssignInstance Associated Types type Rep AssignInstanceResponse :: Type -> Type # Methods from :: AssignInstanceResponse -> Rep AssignInstanceResponse x # to :: Rep AssignInstanceResponse x -> AssignInstanceResponse # | |
Read AssignInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.AssignInstance | |
Show AssignInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.AssignInstance Methods showsPrec :: Int -> AssignInstanceResponse -> ShowS # show :: AssignInstanceResponse -> String # showList :: [AssignInstanceResponse] -> ShowS # | |
NFData AssignInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.AssignInstance Methods rnf :: AssignInstanceResponse -> () # | |
Eq AssignInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.AssignInstance Methods (==) :: AssignInstanceResponse -> AssignInstanceResponse -> Bool # (/=) :: AssignInstanceResponse -> AssignInstanceResponse -> Bool # | |
type Rep AssignInstanceResponse Source # | |
newAssignInstanceResponse :: AssignInstanceResponse Source #
Create a value of AssignInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AssignVolume
data AssignVolume Source #
See: newAssignVolume
smart constructor.
Constructors
AssignVolume' (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> AssignVolume |
Create a value of AssignVolume
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssignVolume
, assignVolume_instanceId
- The instance ID.
AssignVolume
, assignVolume_volumeId
- The volume ID.
data AssignVolumeResponse Source #
See: newAssignVolumeResponse
smart constructor.
Constructors
AssignVolumeResponse' | |
Instances
newAssignVolumeResponse :: AssignVolumeResponse Source #
Create a value of AssignVolumeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AssociateElasticIp
data AssociateElasticIp Source #
See: newAssociateElasticIp
smart constructor.
Constructors
AssociateElasticIp' (Maybe Text) Text |
Instances
newAssociateElasticIp Source #
Arguments
:: Text | |
-> AssociateElasticIp |
Create a value of AssociateElasticIp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AssociateElasticIp
, associateElasticIp_instanceId
- The instance ID.
AssociateElasticIp
, associateElasticIp_elasticIp
- The Elastic IP address.
data AssociateElasticIpResponse Source #
See: newAssociateElasticIpResponse
smart constructor.
Constructors
AssociateElasticIpResponse' | |
Instances
newAssociateElasticIpResponse :: AssociateElasticIpResponse Source #
Create a value of AssociateElasticIpResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
AttachElasticLoadBalancer
data AttachElasticLoadBalancer Source #
See: newAttachElasticLoadBalancer
smart constructor.
Constructors
AttachElasticLoadBalancer' Text Text |
Instances
newAttachElasticLoadBalancer Source #
Arguments
:: Text | |
-> Text | |
-> AttachElasticLoadBalancer |
Create a value of AttachElasticLoadBalancer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
AttachElasticLoadBalancer
, attachElasticLoadBalancer_elasticLoadBalancerName
- The Elastic Load Balancing instance's name.
AttachElasticLoadBalancer
, attachElasticLoadBalancer_layerId
- The ID of the layer to which the Elastic Load Balancing instance is to
be attached.
data AttachElasticLoadBalancerResponse Source #
See: newAttachElasticLoadBalancerResponse
smart constructor.
Constructors
AttachElasticLoadBalancerResponse' | |
Instances
Generic AttachElasticLoadBalancerResponse Source # | |
Defined in Amazonka.OpsWorks.AttachElasticLoadBalancer Associated Types type Rep AttachElasticLoadBalancerResponse :: Type -> Type # | |
Read AttachElasticLoadBalancerResponse Source # | |
Show AttachElasticLoadBalancerResponse Source # | |
Defined in Amazonka.OpsWorks.AttachElasticLoadBalancer Methods showsPrec :: Int -> AttachElasticLoadBalancerResponse -> ShowS # | |
NFData AttachElasticLoadBalancerResponse Source # | |
Defined in Amazonka.OpsWorks.AttachElasticLoadBalancer Methods rnf :: AttachElasticLoadBalancerResponse -> () # | |
Eq AttachElasticLoadBalancerResponse Source # | |
type Rep AttachElasticLoadBalancerResponse Source # | |
Defined in Amazonka.OpsWorks.AttachElasticLoadBalancer |
newAttachElasticLoadBalancerResponse :: AttachElasticLoadBalancerResponse Source #
Create a value of AttachElasticLoadBalancerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
CloneStack
data CloneStack Source #
See: newCloneStack
smart constructor.
Constructors
CloneStack' (Maybe Text) (Maybe (HashMap StackAttributesKeys (Maybe Text))) (Maybe ChefConfiguration) (Maybe [Text]) (Maybe Bool) (Maybe StackConfigurationManager) (Maybe Source) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CloneStack |
Create a value of CloneStack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CloneStack
, cloneStack_agentVersion
- The default AWS OpsWorks Stacks agent version. You have the following
options:
- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
The default setting is LATEST
. To specify an agent version, you must
use the complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
CloneStack
, cloneStack_attributes
- A list of stack attributes and values as key/value pairs to be added to
the cloned stack.
CloneStack
, cloneStack_chefConfiguration
- A ChefConfiguration
object that specifies whether to enable Berkshelf
and the Berkshelf version on Chef 11.10 stacks. For more information,
see
Create a New Stack.
$sel:cloneAppIds:CloneStack'
, cloneStack_cloneAppIds
- A list of source stack app IDs to be included in the cloned stack.
$sel:clonePermissions:CloneStack'
, cloneStack_clonePermissions
- Whether to clone the source stack's permissions.
CloneStack
, cloneStack_configurationManager
- The configuration manager. When you clone a stack we recommend that you
use the configuration manager to specify the Chef version: 12, 11.10, or
11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for
Linux stacks is currently 12.
CloneStack
, cloneStack_customCookbooksSource
- Contains the information required to retrieve an app or cookbook from a
repository. For more information, see
Adding Apps
or
Cookbooks and Recipes.
CloneStack
, cloneStack_customJson
- A string that contains user-defined, custom JSON. It is used to override
the corresponding default stack configuration JSON values. The string
should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
CloneStack
, cloneStack_defaultAvailabilityZone
- The cloned stack's default Availability Zone, which must be in the
specified region. For more information, see
Regions and Endpoints.
If you also specify a value for DefaultSubnetId
, the subnet must be in
the same zone. For more information, see the VpcId
parameter
description.
CloneStack
, cloneStack_defaultInstanceProfileArn
- The Amazon Resource Name (ARN) of an IAM profile that is the default
profile for all of the stack's EC2 instances. For more information
about IAM ARNs, see
Using Identifiers.
CloneStack
, cloneStack_defaultOs
- The stack's operating system, which must be set to one of the
following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. - A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. CentOS Linux 7
Red Hat Enterprise Linux 7
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
.- A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.
The default option is the parent stack's operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.
CloneStack
, cloneStack_defaultRootDeviceType
- The default root device type. This value is used by default for all
instances in the cloned stack, but you can override it when you create
an instance. For more information, see
Storage for the Root Device.
CloneStack
, cloneStack_defaultSshKeyName
- A default Amazon EC2 key pair name. The default value is none. If you
specify a key pair name, AWS OpsWorks installs the public key on the
instance and you can use the private key with an SSH client to log in to
the instance. For more information, see
Using SSH to Communicate with an Instance
and
Managing SSH Access.
You can override this setting by specifying a different key pair, or no
key pair, when you
create an instance.
CloneStack
, cloneStack_defaultSubnetId
- The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId
parameter. All instances are launched
into this subnet unless you specify otherwise when you create the
instance. If you also specify a value for DefaultAvailabilityZone
, the
subnet must be in that zone. For information on default values and when
this parameter is required, see the VpcId
parameter description.
CloneStack
, cloneStack_hostnameTheme
- The stack's host name theme, with spaces are replaced by underscores.
The theme is used to generate host names for the stack's instances. By
default, HostnameTheme
is set to Layer_Dependent
, which creates host
names by appending integers to the layer's short name. The other themes
are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion
, which
returns a host name based on the current theme.
CloneStack
, cloneStack_name
- The cloned stack name.
CloneStack
, cloneStack_region
- The cloned stack AWS region, such as "ap-northeast-2". For more
information about AWS regions, see
Regions and Endpoints.
CloneStack
, cloneStack_useCustomCookbooks
- Whether to use custom cookbooks.
CloneStack
, cloneStack_useOpsworksSecurityGroups
- Whether to associate the AWS OpsWorks Stacks built-in security groups
with the stack's layers.
AWS OpsWorks Stacks provides a standard set of built-in security groups,
one for each layer, which are associated with layers by default. With
UseOpsworksSecurityGroups
you can instead provide your own custom
security groups. UseOpsworksSecurityGroups
has the following settings:
- True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it but you cannot delete the built-in security group.
- False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate Amazon Elastic Compute Cloud (Amazon EC2) security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
CloneStack
, cloneStack_vpcId
- The ID of the VPC that the cloned stack is to be launched into. It must
be in the specified region. All instances are launched into this VPC,
and you cannot change the ID later.
- If your account supports EC2 Classic, the default value is no VPC.
- If your account does not support EC2 Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either
the DefaultAvailabilityZone
or the DefaultSubnetId
parameter only,
AWS OpsWorks Stacks infers the value of the other parameter. If you
specify neither parameter, AWS OpsWorks Stacks sets these parameters to
the first valid Availability Zone for the specified region and the
corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
- It must belong to a VPC in your account that is in the specified region.
- You must specify a value for
DefaultSubnetId
.
For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2 Classic, see Supported Platforms.
$sel:sourceStackId:CloneStack'
, cloneStack_sourceStackId
- The source stack ID.
CloneStack
, cloneStack_serviceRoleArn
- The stack AWS Identity and Access Management (IAM) role, which allows
AWS OpsWorks Stacks to work with AWS resources on your behalf. You must
set this parameter to the Amazon Resource Name (ARN) for an existing IAM
role. If you create a stack by using the AWS OpsWorks Stacks console, it
creates the role for you. You can obtain an existing stack's IAM ARN
programmatically by calling DescribePermissions. For more information
about IAM ARNs, see
Using Identifiers.
You must set this parameter to a valid service role ARN or the action will fail; there is no default value. You can specify the source stack's service role ARN, if you prefer, but you must do so explicitly.
data CloneStackResponse Source #
Contains the response to a CloneStack
request.
See: newCloneStackResponse
smart constructor.
Constructors
CloneStackResponse' (Maybe Text) Int |
Instances
newCloneStackResponse Source #
Arguments
:: Int | |
-> CloneStackResponse |
Create a value of CloneStackResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CloneStackResponse
, cloneStackResponse_stackId
- The cloned stack ID.
$sel:httpStatus:CloneStackResponse'
, cloneStackResponse_httpStatus
- The response's http status code.
CreateApp
See: newCreateApp
smart constructor.
Constructors
CreateApp' (Maybe Source) (Maybe (HashMap AppAttributesKeys Text)) (Maybe [DataSource]) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [EnvironmentVariable]) (Maybe Text) (Maybe SslConfiguration) Text Text AppType |
Instances
Create a value of CreateApp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateApp
, createApp_appSource
- A Source
object that specifies the app repository.
CreateApp
, createApp_attributes
- One or more user-defined key/value pairs to be added to the stack
attributes.
CreateApp
, createApp_dataSources
- The app's data source.
CreateApp
, createApp_description
- A description of the app.
CreateApp
, createApp_domains
- The app virtual host settings, with multiple domains separated by
commas. For example: 'www.example.com, example.com'
CreateApp
, createApp_enableSsl
- Whether to enable SSL for the app.
CreateApp
, createApp_environment
- An array of EnvironmentVariable
objects that specify environment
variables to be associated with the app. After you deploy the app, these
variables are defined on the associated app server instance. For more
information, see
Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20KB)."
If you have specified one or more environment variables, you cannot modify the stack's Chef version.
CreateApp
, createApp_shortname
- The app's short name.
CreateApp
, createApp_sslConfiguration
- An SslConfiguration
object with the SSL configuration.
CreateApp
, createApp_stackId
- The stack ID.
CreateApp
, createApp_name
- The app name.
CreateApp
, createApp_type
- The app type. Each supported type is associated with a particular layer.
For example, PHP applications are associated with a PHP layer. AWS
OpsWorks Stacks deploys an application to those instances that are
members of the corresponding layer. If your app isn't one of the
standard types, or you prefer to implement your own Deploy recipes,
specify other
.
data CreateAppResponse Source #
Contains the response to a CreateApp
request.
See: newCreateAppResponse
smart constructor.
Constructors
CreateAppResponse' (Maybe Text) Int |
Instances
Arguments
:: Int | |
-> CreateAppResponse |
Create a value of CreateAppResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateAppResponse
, createAppResponse_appId
- The app ID.
$sel:httpStatus:CreateAppResponse'
, createAppResponse_httpStatus
- The response's http status code.
CreateDeployment
data CreateDeployment Source #
See: newCreateDeployment
smart constructor.
Constructors
CreateDeployment' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe [Text]) Text DeploymentCommand |
Instances
Arguments
:: Text | |
-> DeploymentCommand | |
-> CreateDeployment |
Create a value of CreateDeployment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDeployment
, createDeployment_appId
- The app ID. This parameter is required for app deployments, but not for
other deployment commands.
CreateDeployment
, createDeployment_comment
- A user-defined comment.
CreateDeployment
, createDeployment_customJson
- A string that contains user-defined, custom JSON. You can use this
parameter to override some corresponding default stack configuration
JSON values. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.
CreateDeployment
, createDeployment_instanceIds
- The instance IDs for the deployment targets.
CreateDeployment
, createDeployment_layerIds
- The layer IDs for the deployment targets.
CreateDeployment
, createDeployment_stackId
- The stack ID.
CreateDeployment
, createDeployment_command
- A DeploymentCommand
object that specifies the deployment command and
any associated arguments.
data CreateDeploymentResponse Source #
Contains the response to a CreateDeployment
request.
See: newCreateDeploymentResponse
smart constructor.
Constructors
CreateDeploymentResponse' (Maybe Text) Int |
Instances
newCreateDeploymentResponse Source #
Create a value of CreateDeploymentResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateDeploymentResponse
, createDeploymentResponse_deploymentId
- The deployment ID, which can be used with other requests to identify the
deployment.
$sel:httpStatus:CreateDeploymentResponse'
, createDeploymentResponse_httpStatus
- The response's http status code.
CreateInstance
data CreateInstance Source #
See: newCreateInstance
smart constructor.
Constructors
CreateInstance' (Maybe Text) (Maybe Text) (Maybe Architecture) (Maybe AutoScalingType) (Maybe Text) (Maybe [BlockDeviceMapping]) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text [Text] Text |
Instances
Arguments
:: Text | |
-> Text | |
-> CreateInstance |
Create a value of CreateInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateInstance
, createInstance_agentVersion
- The default AWS OpsWorks Stacks agent version. You have the following
options:
INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.
The default setting is INHERIT
. To specify an agent version, you must
use the complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
CreateInstance
, createInstance_amiId
- A custom AMI ID to be used to create the instance. The AMI should be
based on one of the supported operating systems. For more information,
see
Using Custom AMIs.
If you specify a custom AMI, you must set Os
to Custom
.
CreateInstance
, createInstance_architecture
- The instance architecture. The default option is x86_64
. Instance
types do not necessarily support both architectures. For a list of the
architectures that are supported by the different instance types, see
Instance Families and Types.
CreateInstance
, createInstance_autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use
only time-based instances.
CreateInstance
, createInstance_availabilityZone
- The instance Availability Zone. For more information, see
Regions and Endpoints.
CreateInstance
, createInstance_blockDeviceMappings
- An array of BlockDeviceMapping
objects that specify the instance's
block devices. For more information, see
Block Device Mapping.
Note that block device mappings are not supported for custom AMIs.
CreateInstance
, createInstance_ebsOptimized
- Whether to create an Amazon EBS-optimized instance.
CreateInstance
, createInstance_hostname
- The instance host name.
CreateInstance
, createInstance_installUpdatesOnBoot
- Whether to install operating system and package updates when the
instance boots. The default value is true
. To control when updates are
installed, set this value to false
. You must then update your
instances manually by using CreateDeployment to run the
update_dependencies
stack command or by manually running yum
(Amazon
Linux) or apt-get
(Ubuntu) on the instances.
We strongly recommend using the default value of true
to ensure that
your instances have the latest security updates.
CreateInstance
, createInstance_os
- The instance's operating system, which must be set to one of the
following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. - A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. CentOS Linux 7
Red Hat Enterprise Linux 7
- A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. - A custom AMI:
Custom
.
For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this
parameter to Custom
, you must use the CreateInstance action's AmiId
parameter to specify the custom AMI that you want to use. Block device
mappings are not supported if the value is Custom
. For more
information about supported operating systems, see
Operating SystemsFor
more information about how to use custom AMIs with AWS OpsWorks Stacks,
see
Using Custom AMIs.
CreateInstance
, createInstance_rootDeviceType
- The instance root device type. For more information, see
Storage for the Root Device.
CreateInstance
, createInstance_sshKeyName
- The instance's Amazon EC2 key-pair name.
CreateInstance
, createInstance_subnetId
- The ID of the instance's subnet. If the stack is running in a VPC, you
can use this parameter to override the stack's default subnet ID value
and direct AWS OpsWorks Stacks to launch the instance in a different
subnet.
CreateInstance
, createInstance_tenancy
- The instance's tenancy option. The default option is no tenancy, or if
the instance is running in a VPC, inherit tenancy settings from the VPC.
The following are valid values for this parameter: dedicated
,
default
, or host
. Because there are costs associated with changes in
tenancy options, we recommend that you research tenancy options before
choosing them for your instances. For more information about dedicated
hosts, see
Dedicated Hosts Overview
and
Amazon EC2 Dedicated Hosts.
For more information about dedicated instances, see
Dedicated Instances
and
Amazon EC2 Dedicated Instances.
CreateInstance
, createInstance_virtualizationType
- The instance's virtualization type, paravirtual
or hvm
.
CreateInstance
, createInstance_stackId
- The stack ID.
CreateInstance
, createInstance_layerIds
- An array that contains the instance's layer IDs.
CreateInstance
, createInstance_instanceType
- The instance type, such as t2.micro
. For a list of supported instance
types, open the stack in the console, choose Instances, and choose
+ Instance. The Size list contains the currently supported
types. For more information, see
Instance Families and Types.
The parameter values that you use to specify the various types are in
the API Name column of the Available Instance Types table.
data CreateInstanceResponse Source #
Contains the response to a CreateInstance
request.
See: newCreateInstanceResponse
smart constructor.
Constructors
CreateInstanceResponse' (Maybe Text) Int |
Instances
newCreateInstanceResponse Source #
Create a value of CreateInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateInstanceResponse
, createInstanceResponse_instanceId
- The instance ID.
$sel:httpStatus:CreateInstanceResponse'
, createInstanceResponse_httpStatus
- The response's http status code.
CreateLayer
data CreateLayer Source #
See: newCreateLayer
smart constructor.
Constructors
CreateLayer' (Maybe (HashMap LayerAttributesKeys (Maybe Text))) (Maybe Bool) (Maybe Bool) (Maybe CloudWatchLogsConfiguration) (Maybe Text) (Maybe Text) (Maybe Recipes) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe LifecycleEventConfiguration) (Maybe [Text]) (Maybe Bool) (Maybe [VolumeConfiguration]) Text LayerType Text Text |
Instances
Arguments
:: Text | |
-> LayerType | |
-> Text | |
-> Text | |
-> CreateLayer |
Create a value of CreateLayer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLayer
, createLayer_attributes
- One or more user-defined key-value pairs to be added to the stack
attributes.
To create a cluster layer, set the EcsClusterArn
attribute to the
cluster's ARN.
CreateLayer
, createLayer_autoAssignElasticIps
- Whether to automatically assign an
Elastic IP address
to the layer's instances. For more information, see
How to Edit a Layer.
CreateLayer
, createLayer_autoAssignPublicIps
- For stacks that are running in a VPC, whether to automatically assign a
public IP address to the layer's instances. For more information, see
How to Edit a Layer.
CreateLayer
, createLayer_cloudWatchLogsConfiguration
- Specifies CloudWatch Logs configuration options for the layer. For more
information, see CloudWatchLogsLogStream.
CreateLayer
, createLayer_customInstanceProfileArn
- The ARN of an IAM profile to be used for the layer's EC2 instances. For
more information about IAM ARNs, see
Using Identifiers.
CreateLayer
, createLayer_customJson
- A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's instances. For
more information, see
Using Custom JSON.
This feature is supported as of version 1.7.42 of the AWS CLI.
CreateLayer
, createLayer_customRecipes
- A LayerCustomRecipes
object that specifies the layer custom recipes.
CreateLayer
, createLayer_customSecurityGroupIds
- An array containing the layer custom security group IDs.
CreateLayer
, createLayer_enableAutoHealing
- Whether to disable auto healing for the layer.
CreateLayer
, createLayer_installUpdatesOnBoot
- Whether to install operating system and package updates when the
instance boots. The default value is true
. To control when updates are
installed, set this value to false
. You must then update your
instances manually by using CreateDeployment to run the
update_dependencies
stack command or by manually running yum
(Amazon
Linux) or apt-get
(Ubuntu) on the instances.
To ensure that your instances have the latest security updates, we
strongly recommend using the default value of true
.
CreateLayer
, createLayer_lifecycleEventConfiguration
- A LifeCycleEventConfiguration
object that you can use to configure the
Shutdown event to specify an execution timeout and enable or disable
Elastic Load Balancer connection draining.
CreateLayer
, createLayer_packages
- An array of Package
objects that describes the layer packages.
CreateLayer
, createLayer_useEbsOptimizedInstances
- Whether to use Amazon EBS-optimized instances.
CreateLayer
, createLayer_volumeConfigurations
- A VolumeConfigurations
object that describes the layer's Amazon EBS
volumes.
CreateLayer
, createLayer_stackId
- The layer stack ID.
CreateLayer
, createLayer_type
- The layer type. A stack cannot have more than one built-in layer of the
same type. It can have any number of custom layers. Built-in layers are
not available in Chef 12 stacks.
CreateLayer
, createLayer_name
- The layer name, which is used by the console.
CreateLayer
, createLayer_shortname
- For custom layers only, use this parameter to specify the layer's short
name, which is used internally by AWS OpsWorks Stacks and by Chef
recipes. The short name is also used as the name for the directory where
your app files are installed. It can have a maximum of 200 characters,
which are limited to the alphanumeric characters, '-', '_', and
'.'.
The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference.
data CreateLayerResponse Source #
Contains the response to a CreateLayer
request.
See: newCreateLayerResponse
smart constructor.
Constructors
CreateLayerResponse' (Maybe Text) Int |
Instances
newCreateLayerResponse Source #
Arguments
:: Int | |
-> CreateLayerResponse |
Create a value of CreateLayerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateLayerResponse
, createLayerResponse_layerId
- The layer ID.
$sel:httpStatus:CreateLayerResponse'
, createLayerResponse_httpStatus
- The response's http status code.
CreateStack
data CreateStack Source #
See: newCreateStack
smart constructor.
Constructors
CreateStack' (Maybe Text) (Maybe (HashMap StackAttributesKeys (Maybe Text))) (Maybe ChefConfiguration) (Maybe StackConfigurationManager) (Maybe Source) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) Text Text Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> CreateStack |
Create a value of CreateStack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStack
, createStack_agentVersion
- The default AWS OpsWorks Stacks agent version. You have the following
options:
- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
The default setting is the most recent release of the agent. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
CreateStack
, createStack_attributes
- One or more user-defined key-value pairs to be added to the stack
attributes.
CreateStack
, createStack_chefConfiguration
- A ChefConfiguration
object that specifies whether to enable Berkshelf
and the Berkshelf version on Chef 11.10 stacks. For more information,
see
Create a New Stack.
CreateStack
, createStack_configurationManager
- The configuration manager. When you create a stack we recommend that you
use the configuration manager to specify the Chef version: 12, 11.10, or
11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for
Linux stacks is currently 12.
CreateStack
, createStack_customCookbooksSource
- Contains the information required to retrieve an app or cookbook from a
repository. For more information, see
Adding Apps
or
Cookbooks and Recipes.
CreateStack
, createStack_customJson
- A string that contains user-defined, custom JSON. It can be used to
override the corresponding default stack configuration attribute values
or to pass data to recipes. The string should be in the following
format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
CreateStack
, createStack_defaultAvailabilityZone
- The stack's default Availability Zone, which must be in the specified
region. For more information, see
Regions and Endpoints.
If you also specify a value for DefaultSubnetId
, the subnet must be in
the same zone. For more information, see the VpcId
parameter
description.
CreateStack
, createStack_defaultOs
- The stack's default operating system, which is installed on every
instance unless you specify a different operating system when you create
the instance. You can specify one of the following.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. - A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. CentOS Linux 7
Red Hat Enterprise Linux 7
- A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. - A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs.
The default option is the current Amazon Linux version. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
CreateStack
, createStack_defaultRootDeviceType
- The default root device type. This value is the default for all
instances in the stack, but you can override it when you create an
instance. The default option is instance-store
. For more information,
see
Storage for the Root Device.
CreateStack
, createStack_defaultSshKeyName
- A default Amazon EC2 key pair name. The default value is none. If you
specify a key pair name, AWS OpsWorks installs the public key on the
instance and you can use the private key with an SSH client to log in to
the instance. For more information, see
Using SSH to Communicate with an Instance
and
Managing SSH Access.
You can override this setting by specifying a different key pair, or no
key pair, when you
create an instance.
CreateStack
, createStack_defaultSubnetId
- The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId
parameter. All instances are launched
into this subnet unless you specify otherwise when you create the
instance. If you also specify a value for DefaultAvailabilityZone
, the
subnet must be in that zone. For information on default values and when
this parameter is required, see the VpcId
parameter description.
CreateStack
, createStack_hostnameTheme
- The stack's host name theme, with spaces replaced by underscores. The
theme is used to generate host names for the stack's instances. By
default, HostnameTheme
is set to Layer_Dependent
, which creates host
names by appending integers to the layer's short name. The other themes
are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion
, which
returns a host name based on the current theme.
CreateStack
, createStack_useCustomCookbooks
- Whether the stack uses custom cookbooks.
CreateStack
, createStack_useOpsworksSecurityGroups
- Whether to associate the AWS OpsWorks Stacks built-in security groups
with the stack's layers.
AWS OpsWorks Stacks provides a standard set of built-in security groups,
one for each layer, which are associated with layers by default. With
UseOpsworksSecurityGroups
you can instead provide your own custom
security groups. UseOpsworksSecurityGroups
has the following settings:
- True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
- False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
CreateStack
, createStack_vpcId
- The ID of the VPC that the stack is to be launched into. The VPC must be
in the stack's region. All instances are launched into this VPC. You
cannot change the ID later.
- If your account supports EC2-Classic, the default value is
no VPC
. - If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
If the VPC ID corresponds to a default VPC and you have specified either
the DefaultAvailabilityZone
or the DefaultSubnetId
parameter only,
AWS OpsWorks Stacks infers the value of the other parameter. If you
specify neither parameter, AWS OpsWorks Stacks sets these parameters to
the first valid Availability Zone for the specified region and the
corresponding default VPC subnet ID, respectively.
If you specify a nondefault VPC ID, note the following:
- It must belong to a VPC in your account that is in the specified region.
- You must specify a value for
DefaultSubnetId
.
For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC. For more information about default VPC and EC2-Classic, see Supported Platforms.
CreateStack
, createStack_name
- The stack name.
CreateStack
, createStack_region
- The stack's AWS region, such as ap-south-1
. For more information
about Amazon regions, see
Regions and Endpoints.
In the AWS CLI, this API maps to the --stack-region
parameter. If the
--stack-region
parameter and the AWS CLI common parameter --region
are set to the same value, the stack uses a regional endpoint. If the
--stack-region
parameter is not set, but the AWS CLI --region
parameter is, this also results in a stack with a regional endpoint.
However, if the --region
parameter is set to us-east-1
, and the
--stack-region
parameter is set to one of the following, then the
stack uses a legacy or classic region:
us-west-1, us-west-2, sa-east-1, eu-central-1, eu-west-1, ap-northeast-1, ap-southeast-1, ap-southeast-2
.
In this case, the actual API endpoint of the stack is in us-east-1
.
Only the preceding regions are supported as classic regions in the
us-east-1
API endpoint. Because it is a best practice to choose the
regional endpoint that is closest to where you manage AWS, we recommend
that you use regional endpoints for new stacks. The AWS CLI common
--region
parameter always specifies a regional API endpoint; it cannot
be used to specify a classic AWS OpsWorks Stacks region.
CreateStack
, createStack_serviceRoleArn
- The stack's AWS Identity and Access Management (IAM) role, which allows
AWS OpsWorks Stacks to work with AWS resources on your behalf. You must
set this parameter to the Amazon Resource Name (ARN) for an existing IAM
role. For more information about IAM ARNs, see
Using Identifiers.
CreateStack
, createStack_defaultInstanceProfileArn
- The Amazon Resource Name (ARN) of an IAM profile that is the default
profile for all of the stack's EC2 instances. For more information
about IAM ARNs, see
Using Identifiers.
data CreateStackResponse Source #
Contains the response to a CreateStack
request.
See: newCreateStackResponse
smart constructor.
Constructors
CreateStackResponse' (Maybe Text) Int |
Instances
newCreateStackResponse Source #
Arguments
:: Int | |
-> CreateStackResponse |
Create a value of CreateStackResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateStackResponse
, createStackResponse_stackId
- The stack ID, which is an opaque string that you use to identify the
stack when performing actions such as DescribeStacks
.
$sel:httpStatus:CreateStackResponse'
, createStackResponse_httpStatus
- The response's http status code.
CreateUserProfile
data CreateUserProfile Source #
See: newCreateUserProfile
smart constructor.
Instances
Arguments
:: Text | |
-> CreateUserProfile |
Create a value of CreateUserProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUserProfile
, createUserProfile_allowSelfManagement
- Whether users can specify their own SSH public key through the My
Settings page. For more information, see
Setting an IAM User's Public SSH Key.
CreateUserProfile
, createUserProfile_sshPublicKey
- The user's public SSH key.
CreateUserProfile
, createUserProfile_sshUsername
- The user's SSH user name. The allowable characters are [a-z], [A-Z],
[0-9], '-', and '_'. If the specified name includes other
punctuation marks, AWS OpsWorks Stacks removes them. For example,
my.name
will be changed to myname
. If you do not specify an SSH user
name, AWS OpsWorks Stacks generates one from the IAM user name.
CreateUserProfile
, createUserProfile_iamUserArn
- The user's IAM ARN; this can also be a federated user's ARN.
data CreateUserProfileResponse Source #
Contains the response to a CreateUserProfile
request.
See: newCreateUserProfileResponse
smart constructor.
Constructors
CreateUserProfileResponse' (Maybe Text) Int |
Instances
newCreateUserProfileResponse Source #
Create a value of CreateUserProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
CreateUserProfile
, createUserProfileResponse_iamUserArn
- The user's IAM ARN.
$sel:httpStatus:CreateUserProfileResponse'
, createUserProfileResponse_httpStatus
- The response's http status code.
DeleteApp
See: newDeleteApp
smart constructor.
Constructors
DeleteApp' Text |
Instances
Create a value of DeleteApp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteApp
, deleteApp_appId
- The app ID.
data DeleteAppResponse Source #
See: newDeleteAppResponse
smart constructor.
Constructors
DeleteAppResponse' | |
Instances
Generic DeleteAppResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteApp Associated Types type Rep DeleteAppResponse :: Type -> Type # Methods from :: DeleteAppResponse -> Rep DeleteAppResponse x # to :: Rep DeleteAppResponse x -> DeleteAppResponse # | |
Read DeleteAppResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteApp Methods readsPrec :: Int -> ReadS DeleteAppResponse # readList :: ReadS [DeleteAppResponse] # | |
Show DeleteAppResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteApp Methods showsPrec :: Int -> DeleteAppResponse -> ShowS # show :: DeleteAppResponse -> String # showList :: [DeleteAppResponse] -> ShowS # | |
NFData DeleteAppResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteApp Methods rnf :: DeleteAppResponse -> () # | |
Eq DeleteAppResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteApp Methods (==) :: DeleteAppResponse -> DeleteAppResponse -> Bool # (/=) :: DeleteAppResponse -> DeleteAppResponse -> Bool # | |
type Rep DeleteAppResponse Source # | |
newDeleteAppResponse :: DeleteAppResponse Source #
Create a value of DeleteAppResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteInstance
data DeleteInstance Source #
See: newDeleteInstance
smart constructor.
Instances
Arguments
:: Text | |
-> DeleteInstance |
Create a value of DeleteInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteElasticIp:DeleteInstance'
, deleteInstance_deleteElasticIp
- Whether to delete the instance Elastic IP address.
$sel:deleteVolumes:DeleteInstance'
, deleteInstance_deleteVolumes
- Whether to delete the instance's Amazon EBS volumes.
DeleteInstance
, deleteInstance_instanceId
- The instance ID.
data DeleteInstanceResponse Source #
See: newDeleteInstanceResponse
smart constructor.
Constructors
DeleteInstanceResponse' | |
Instances
Generic DeleteInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteInstance Associated Types type Rep DeleteInstanceResponse :: Type -> Type # Methods from :: DeleteInstanceResponse -> Rep DeleteInstanceResponse x # to :: Rep DeleteInstanceResponse x -> DeleteInstanceResponse # | |
Read DeleteInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteInstance | |
Show DeleteInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteInstance Methods showsPrec :: Int -> DeleteInstanceResponse -> ShowS # show :: DeleteInstanceResponse -> String # showList :: [DeleteInstanceResponse] -> ShowS # | |
NFData DeleteInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteInstance Methods rnf :: DeleteInstanceResponse -> () # | |
Eq DeleteInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeleteInstance Methods (==) :: DeleteInstanceResponse -> DeleteInstanceResponse -> Bool # (/=) :: DeleteInstanceResponse -> DeleteInstanceResponse -> Bool # | |
type Rep DeleteInstanceResponse Source # | |
newDeleteInstanceResponse :: DeleteInstanceResponse Source #
Create a value of DeleteInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteLayer
data DeleteLayer Source #
See: newDeleteLayer
smart constructor.
Constructors
DeleteLayer' Text |
Instances
Arguments
:: Text | |
-> DeleteLayer |
Create a value of DeleteLayer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteLayer
, deleteLayer_layerId
- The layer ID.
data DeleteLayerResponse Source #
See: newDeleteLayerResponse
smart constructor.
Constructors
DeleteLayerResponse' | |
Instances
newDeleteLayerResponse :: DeleteLayerResponse Source #
Create a value of DeleteLayerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteStack
data DeleteStack Source #
See: newDeleteStack
smart constructor.
Constructors
DeleteStack' Text |
Instances
Arguments
:: Text | |
-> DeleteStack |
Create a value of DeleteStack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteStack
, deleteStack_stackId
- The stack ID.
data DeleteStackResponse Source #
See: newDeleteStackResponse
smart constructor.
Constructors
DeleteStackResponse' | |
Instances
newDeleteStackResponse :: DeleteStackResponse Source #
Create a value of DeleteStackResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeleteUserProfile
data DeleteUserProfile Source #
See: newDeleteUserProfile
smart constructor.
Constructors
DeleteUserProfile' Text |
Instances
Arguments
:: Text | |
-> DeleteUserProfile |
Create a value of DeleteUserProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeleteUserProfile
, deleteUserProfile_iamUserArn
- The user's IAM ARN. This can also be a federated user's ARN.
data DeleteUserProfileResponse Source #
See: newDeleteUserProfileResponse
smart constructor.
Constructors
DeleteUserProfileResponse' | |
Instances
newDeleteUserProfileResponse :: DeleteUserProfileResponse Source #
Create a value of DeleteUserProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeregisterEcsCluster
data DeregisterEcsCluster Source #
See: newDeregisterEcsCluster
smart constructor.
Constructors
DeregisterEcsCluster' Text |
Instances
newDeregisterEcsCluster Source #
Arguments
:: Text | |
-> DeregisterEcsCluster |
Create a value of DeregisterEcsCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeregisterEcsCluster
, deregisterEcsCluster_ecsClusterArn
- The cluster's Amazon Resource Number (ARN).
data DeregisterEcsClusterResponse Source #
See: newDeregisterEcsClusterResponse
smart constructor.
Constructors
DeregisterEcsClusterResponse' | |
Instances
Generic DeregisterEcsClusterResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterEcsCluster Associated Types type Rep DeregisterEcsClusterResponse :: Type -> Type # | |
Read DeregisterEcsClusterResponse Source # | |
Show DeregisterEcsClusterResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterEcsCluster Methods showsPrec :: Int -> DeregisterEcsClusterResponse -> ShowS # show :: DeregisterEcsClusterResponse -> String # showList :: [DeregisterEcsClusterResponse] -> ShowS # | |
NFData DeregisterEcsClusterResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterEcsCluster Methods rnf :: DeregisterEcsClusterResponse -> () # | |
Eq DeregisterEcsClusterResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterEcsCluster Methods (==) :: DeregisterEcsClusterResponse -> DeregisterEcsClusterResponse -> Bool # (/=) :: DeregisterEcsClusterResponse -> DeregisterEcsClusterResponse -> Bool # | |
type Rep DeregisterEcsClusterResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterEcsCluster |
newDeregisterEcsClusterResponse :: DeregisterEcsClusterResponse Source #
Create a value of DeregisterEcsClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeregisterElasticIp
data DeregisterElasticIp Source #
See: newDeregisterElasticIp
smart constructor.
Constructors
DeregisterElasticIp' Text |
Instances
newDeregisterElasticIp Source #
Arguments
:: Text | |
-> DeregisterElasticIp |
Create a value of DeregisterElasticIp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeregisterElasticIp
, deregisterElasticIp_elasticIp
- The Elastic IP address.
data DeregisterElasticIpResponse Source #
See: newDeregisterElasticIpResponse
smart constructor.
Constructors
DeregisterElasticIpResponse' | |
Instances
newDeregisterElasticIpResponse :: DeregisterElasticIpResponse Source #
Create a value of DeregisterElasticIpResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeregisterInstance
data DeregisterInstance Source #
See: newDeregisterInstance
smart constructor.
Constructors
DeregisterInstance' Text |
Instances
newDeregisterInstance Source #
Arguments
:: Text | |
-> DeregisterInstance |
Create a value of DeregisterInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeregisterInstance
, deregisterInstance_instanceId
- The instance ID.
data DeregisterInstanceResponse Source #
See: newDeregisterInstanceResponse
smart constructor.
Constructors
DeregisterInstanceResponse' | |
Instances
newDeregisterInstanceResponse :: DeregisterInstanceResponse Source #
Create a value of DeregisterInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeregisterRdsDbInstance
data DeregisterRdsDbInstance Source #
See: newDeregisterRdsDbInstance
smart constructor.
Constructors
DeregisterRdsDbInstance' Text |
Instances
newDeregisterRdsDbInstance Source #
Arguments
:: Text | |
-> DeregisterRdsDbInstance |
Create a value of DeregisterRdsDbInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeregisterRdsDbInstance
, deregisterRdsDbInstance_rdsDbInstanceArn
- The Amazon RDS instance's ARN.
data DeregisterRdsDbInstanceResponse Source #
See: newDeregisterRdsDbInstanceResponse
smart constructor.
Constructors
DeregisterRdsDbInstanceResponse' | |
Instances
Generic DeregisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterRdsDbInstance Associated Types type Rep DeregisterRdsDbInstanceResponse :: Type -> Type # | |
Read DeregisterRdsDbInstanceResponse Source # | |
Show DeregisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterRdsDbInstance Methods showsPrec :: Int -> DeregisterRdsDbInstanceResponse -> ShowS # | |
NFData DeregisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterRdsDbInstance Methods rnf :: DeregisterRdsDbInstanceResponse -> () # | |
Eq DeregisterRdsDbInstanceResponse Source # | |
type Rep DeregisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.DeregisterRdsDbInstance |
newDeregisterRdsDbInstanceResponse :: DeregisterRdsDbInstanceResponse Source #
Create a value of DeregisterRdsDbInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DeregisterVolume
data DeregisterVolume Source #
See: newDeregisterVolume
smart constructor.
Constructors
DeregisterVolume' Text |
Instances
Arguments
:: Text | |
-> DeregisterVolume |
Create a value of DeregisterVolume
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DeregisterVolume
, deregisterVolume_volumeId
- The AWS OpsWorks Stacks volume ID, which is the GUID that AWS OpsWorks
Stacks assigned to the instance when you registered the volume with the
stack, not the Amazon EC2 volume ID.
data DeregisterVolumeResponse Source #
See: newDeregisterVolumeResponse
smart constructor.
Constructors
DeregisterVolumeResponse' | |
Instances
newDeregisterVolumeResponse :: DeregisterVolumeResponse Source #
Create a value of DeregisterVolumeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DescribeAgentVersions
data DescribeAgentVersions Source #
See: newDescribeAgentVersions
smart constructor.
Constructors
DescribeAgentVersions' (Maybe StackConfigurationManager) (Maybe Text) |
Instances
newDescribeAgentVersions :: DescribeAgentVersions Source #
Create a value of DescribeAgentVersions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeAgentVersions
, describeAgentVersions_configurationManager
- The configuration manager.
DescribeAgentVersions
, describeAgentVersions_stackId
- The stack ID.
data DescribeAgentVersionsResponse Source #
Contains the response to a DescribeAgentVersions
request.
See: newDescribeAgentVersionsResponse
smart constructor.
Constructors
DescribeAgentVersionsResponse' (Maybe [AgentVersion]) Int |
Instances
newDescribeAgentVersionsResponse Source #
Create a value of DescribeAgentVersionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentVersions:DescribeAgentVersionsResponse'
, describeAgentVersionsResponse_agentVersions
- The agent versions for the specified stack or configuration manager.
Note that this value is the complete version number, not the abbreviated
number used by the console.
$sel:httpStatus:DescribeAgentVersionsResponse'
, describeAgentVersionsResponse_httpStatus
- The response's http status code.
DescribeApps
data DescribeApps Source #
See: newDescribeApps
smart constructor.
Constructors
DescribeApps' (Maybe [Text]) (Maybe Text) |
Instances
newDescribeApps :: DescribeApps Source #
Create a value of DescribeApps
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appIds:DescribeApps'
, describeApps_appIds
- An array of app IDs for the apps to be described. If you use this
parameter, DescribeApps
returns a description of the specified apps.
Otherwise, it returns a description of every app.
DescribeApps
, describeApps_stackId
- The app stack ID. If you use this parameter, DescribeApps
returns a
description of the apps in the specified stack.
data DescribeAppsResponse Source #
Contains the response to a DescribeApps
request.
See: newDescribeAppsResponse
smart constructor.
Constructors
DescribeAppsResponse' (Maybe [App]) Int |
Instances
newDescribeAppsResponse Source #
Arguments
:: Int | |
-> DescribeAppsResponse |
Create a value of DescribeAppsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:apps:DescribeAppsResponse'
, describeAppsResponse_apps
- An array of App
objects that describe the specified apps.
$sel:httpStatus:DescribeAppsResponse'
, describeAppsResponse_httpStatus
- The response's http status code.
DescribeCommands
data DescribeCommands Source #
See: newDescribeCommands
smart constructor.
Instances
newDescribeCommands :: DescribeCommands Source #
Create a value of DescribeCommands
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:commandIds:DescribeCommands'
, describeCommands_commandIds
- An array of command IDs. If you include this parameter,
DescribeCommands
returns a description of the specified commands.
Otherwise, it returns a description of every command.
DescribeCommands
, describeCommands_deploymentId
- The deployment ID. If you include this parameter, DescribeCommands
returns a description of the commands associated with the specified
deployment.
DescribeCommands
, describeCommands_instanceId
- The instance ID. If you include this parameter, DescribeCommands
returns a description of the commands associated with the specified
instance.
data DescribeCommandsResponse Source #
Contains the response to a DescribeCommands
request.
See: newDescribeCommandsResponse
smart constructor.
Constructors
DescribeCommandsResponse' (Maybe [Command]) Int |
Instances
newDescribeCommandsResponse Source #
Create a value of DescribeCommandsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:commands:DescribeCommandsResponse'
, describeCommandsResponse_commands
- An array of Command
objects that describe each of the specified
commands.
$sel:httpStatus:DescribeCommandsResponse'
, describeCommandsResponse_httpStatus
- The response's http status code.
DescribeDeployments
data DescribeDeployments Source #
See: newDescribeDeployments
smart constructor.
Instances
newDescribeDeployments :: DescribeDeployments Source #
Create a value of DescribeDeployments
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeDeployments
, describeDeployments_appId
- The app ID. If you include this parameter, the command returns a
description of the commands associated with the specified app.
$sel:deploymentIds:DescribeDeployments'
, describeDeployments_deploymentIds
- An array of deployment IDs to be described. If you include this
parameter, the command returns a description of the specified
deployments. Otherwise, it returns a description of every deployment.
DescribeDeployments
, describeDeployments_stackId
- The stack ID. If you include this parameter, the command returns a
description of the commands associated with the specified stack.
data DescribeDeploymentsResponse Source #
Contains the response to a DescribeDeployments
request.
See: newDescribeDeploymentsResponse
smart constructor.
Constructors
DescribeDeploymentsResponse' (Maybe [Deployment]) Int |
Instances
newDescribeDeploymentsResponse Source #
Create a value of DescribeDeploymentsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deployments:DescribeDeploymentsResponse'
, describeDeploymentsResponse_deployments
- An array of Deployment
objects that describe the deployments.
$sel:httpStatus:DescribeDeploymentsResponse'
, describeDeploymentsResponse_httpStatus
- The response's http status code.
DescribeEcsClusters (Paginated)
data DescribeEcsClusters Source #
See: newDescribeEcsClusters
smart constructor.
Instances
newDescribeEcsClusters :: DescribeEcsClusters Source #
Create a value of DescribeEcsClusters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ecsClusterArns:DescribeEcsClusters'
, describeEcsClusters_ecsClusterArns
- A list of ARNs, one for each cluster to be described.
$sel:maxResults:DescribeEcsClusters'
, describeEcsClusters_maxResults
- To receive a paginated response, use this parameter to specify the
maximum number of results to be returned with a single call. If the
number of available results exceeds this maximum, the response includes
a NextToken
value that you can assign to the NextToken
request
parameter to get the next set of results.
DescribeEcsClusters
, describeEcsClusters_nextToken
- If the previous paginated request did not return all of the remaining
results, the response object'sNextToken
parameter value is set to a
token. To retrieve the next set of results, call DescribeEcsClusters
again and assign that token to the request object's NextToken
parameter. If there are no remaining results, the previous response
object's NextToken
parameter is set to null
.
DescribeEcsClusters
, describeEcsClusters_stackId
- A stack ID. DescribeEcsClusters
returns a description of the cluster
that is registered with the stack.
data DescribeEcsClustersResponse Source #
Contains the response to a DescribeEcsClusters
request.
See: newDescribeEcsClustersResponse
smart constructor.
Constructors
DescribeEcsClustersResponse' (Maybe [EcsCluster]) (Maybe Text) Int |
Instances
newDescribeEcsClustersResponse Source #
Create a value of DescribeEcsClustersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ecsClusters:DescribeEcsClustersResponse'
, describeEcsClustersResponse_ecsClusters
- A list of EcsCluster
objects containing the cluster descriptions.
DescribeEcsClusters
, describeEcsClustersResponse_nextToken
- If a paginated request does not return all of the remaining results,
this parameter is set to a token that you can assign to the request
object's NextToken
parameter to retrieve the next set of results. If
the previous paginated request returned all of the remaining results,
this parameter is set to null
.
$sel:httpStatus:DescribeEcsClustersResponse'
, describeEcsClustersResponse_httpStatus
- The response's http status code.
DescribeElasticIps
data DescribeElasticIps Source #
See: newDescribeElasticIps
smart constructor.
Instances
newDescribeElasticIps :: DescribeElasticIps Source #
Create a value of DescribeElasticIps
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeElasticIps
, describeElasticIps_instanceId
- The instance ID. If you include this parameter, DescribeElasticIps
returns a description of the Elastic IP addresses associated with the
specified instance.
$sel:ips:DescribeElasticIps'
, describeElasticIps_ips
- An array of Elastic IP addresses to be described. If you include this
parameter, DescribeElasticIps
returns a description of the specified
Elastic IP addresses. Otherwise, it returns a description of every
Elastic IP address.
DescribeElasticIps
, describeElasticIps_stackId
- A stack ID. If you include this parameter, DescribeElasticIps
returns
a description of the Elastic IP addresses that are registered with the
specified stack.
data DescribeElasticIpsResponse Source #
Contains the response to a DescribeElasticIps
request.
See: newDescribeElasticIpsResponse
smart constructor.
Constructors
DescribeElasticIpsResponse' (Maybe [ElasticIp]) Int |
Instances
newDescribeElasticIpsResponse Source #
Create a value of DescribeElasticIpsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:elasticIps:DescribeElasticIpsResponse'
, describeElasticIpsResponse_elasticIps
- An ElasticIps
object that describes the specified Elastic IP
addresses.
$sel:httpStatus:DescribeElasticIpsResponse'
, describeElasticIpsResponse_httpStatus
- The response's http status code.
DescribeElasticLoadBalancers
data DescribeElasticLoadBalancers Source #
See: newDescribeElasticLoadBalancers
smart constructor.
Constructors
DescribeElasticLoadBalancers' (Maybe [Text]) (Maybe Text) |
Instances
newDescribeElasticLoadBalancers :: DescribeElasticLoadBalancers Source #
Create a value of DescribeElasticLoadBalancers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeElasticLoadBalancers
, describeElasticLoadBalancers_layerIds
- A list of layer IDs. The action describes the Elastic Load Balancing
instances for the specified layers.
DescribeElasticLoadBalancers
, describeElasticLoadBalancers_stackId
- A stack ID. The action describes the stack's Elastic Load Balancing
instances.
data DescribeElasticLoadBalancersResponse Source #
Contains the response to a DescribeElasticLoadBalancers
request.
See: newDescribeElasticLoadBalancersResponse
smart constructor.
Constructors
DescribeElasticLoadBalancersResponse' (Maybe [ElasticLoadBalancer]) Int |
Instances
newDescribeElasticLoadBalancersResponse Source #
Arguments
:: Int | |
-> DescribeElasticLoadBalancersResponse |
Create a value of DescribeElasticLoadBalancersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:elasticLoadBalancers:DescribeElasticLoadBalancersResponse'
, describeElasticLoadBalancersResponse_elasticLoadBalancers
- A list of ElasticLoadBalancer
objects that describe the specified
Elastic Load Balancing instances.
$sel:httpStatus:DescribeElasticLoadBalancersResponse'
, describeElasticLoadBalancersResponse_httpStatus
- The response's http status code.
DescribeInstances
data DescribeInstances Source #
See: newDescribeInstances
smart constructor.
Instances
newDescribeInstances :: DescribeInstances Source #
Create a value of DescribeInstances
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeInstances
, describeInstances_instanceIds
- An array of instance IDs to be described. If you use this parameter,
DescribeInstances
returns a description of the specified instances.
Otherwise, it returns a description of every instance.
DescribeInstances
, describeInstances_layerId
- A layer ID. If you use this parameter, DescribeInstances
returns
descriptions of the instances associated with the specified layer.
DescribeInstances
, describeInstances_stackId
- A stack ID. If you use this parameter, DescribeInstances
returns
descriptions of the instances associated with the specified stack.
data DescribeInstancesResponse Source #
Contains the response to a DescribeInstances
request.
See: newDescribeInstancesResponse
smart constructor.
Constructors
DescribeInstancesResponse' (Maybe [Instance]) Int |
Instances
newDescribeInstancesResponse Source #
Create a value of DescribeInstancesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instances:DescribeInstancesResponse'
, describeInstancesResponse_instances
- An array of Instance
objects that describe the instances.
$sel:httpStatus:DescribeInstancesResponse'
, describeInstancesResponse_httpStatus
- The response's http status code.
DescribeLayers
data DescribeLayers Source #
See: newDescribeLayers
smart constructor.
Constructors
DescribeLayers' (Maybe [Text]) (Maybe Text) |
Instances
newDescribeLayers :: DescribeLayers Source #
Create a value of DescribeLayers
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLayers
, describeLayers_layerIds
- An array of layer IDs that specify the layers to be described. If you
omit this parameter, DescribeLayers
returns a description of every
layer in the specified stack.
DescribeLayers
, describeLayers_stackId
- The stack ID.
data DescribeLayersResponse Source #
Contains the response to a DescribeLayers
request.
See: newDescribeLayersResponse
smart constructor.
Constructors
DescribeLayersResponse' (Maybe [Layer]) Int |
Instances
newDescribeLayersResponse Source #
Create a value of DescribeLayersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:layers:DescribeLayersResponse'
, describeLayersResponse_layers
- An array of Layer
objects that describe the layers.
$sel:httpStatus:DescribeLayersResponse'
, describeLayersResponse_httpStatus
- The response's http status code.
DescribeLoadBasedAutoScaling
data DescribeLoadBasedAutoScaling Source #
See: newDescribeLoadBasedAutoScaling
smart constructor.
Constructors
DescribeLoadBasedAutoScaling' [Text] |
Instances
newDescribeLoadBasedAutoScaling :: DescribeLoadBasedAutoScaling Source #
Create a value of DescribeLoadBasedAutoScaling
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeLoadBasedAutoScaling
, describeLoadBasedAutoScaling_layerIds
- An array of layer IDs.
data DescribeLoadBasedAutoScalingResponse Source #
Contains the response to a DescribeLoadBasedAutoScaling
request.
See: newDescribeLoadBasedAutoScalingResponse
smart constructor.
Instances
newDescribeLoadBasedAutoScalingResponse Source #
Arguments
:: Int | |
-> DescribeLoadBasedAutoScalingResponse |
Create a value of DescribeLoadBasedAutoScalingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:loadBasedAutoScalingConfigurations:DescribeLoadBasedAutoScalingResponse'
, describeLoadBasedAutoScalingResponse_loadBasedAutoScalingConfigurations
- An array of LoadBasedAutoScalingConfiguration
objects that describe
each layer's configuration.
$sel:httpStatus:DescribeLoadBasedAutoScalingResponse'
, describeLoadBasedAutoScalingResponse_httpStatus
- The response's http status code.
DescribeMyUserProfile
data DescribeMyUserProfile Source #
See: newDescribeMyUserProfile
smart constructor.
Constructors
DescribeMyUserProfile' | |
Instances
newDescribeMyUserProfile :: DescribeMyUserProfile Source #
Create a value of DescribeMyUserProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeMyUserProfileResponse Source #
Contains the response to a DescribeMyUserProfile
request.
See: newDescribeMyUserProfileResponse
smart constructor.
Constructors
DescribeMyUserProfileResponse' (Maybe SelfUserProfile) Int |
Instances
newDescribeMyUserProfileResponse Source #
Create a value of DescribeMyUserProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userProfile:DescribeMyUserProfileResponse'
, describeMyUserProfileResponse_userProfile
- A UserProfile
object that describes the user's SSH information.
$sel:httpStatus:DescribeMyUserProfileResponse'
, describeMyUserProfileResponse_httpStatus
- The response's http status code.
DescribeOperatingSystems
data DescribeOperatingSystems Source #
See: newDescribeOperatingSystems
smart constructor.
Constructors
DescribeOperatingSystems' | |
Instances
newDescribeOperatingSystems :: DescribeOperatingSystems Source #
Create a value of DescribeOperatingSystems
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
data DescribeOperatingSystemsResponse Source #
The response to a DescribeOperatingSystems
request.
See: newDescribeOperatingSystemsResponse
smart constructor.
Constructors
DescribeOperatingSystemsResponse' (Maybe [OperatingSystem]) Int |
Instances
newDescribeOperatingSystemsResponse Source #
Create a value of DescribeOperatingSystemsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:operatingSystems:DescribeOperatingSystemsResponse'
, describeOperatingSystemsResponse_operatingSystems
- Contains information in response to a DescribeOperatingSystems
request.
$sel:httpStatus:DescribeOperatingSystemsResponse'
, describeOperatingSystemsResponse_httpStatus
- The response's http status code.
DescribePermissions
data DescribePermissions Source #
See: newDescribePermissions
smart constructor.
Constructors
DescribePermissions' (Maybe Text) (Maybe Text) |
Instances
newDescribePermissions :: DescribePermissions Source #
Create a value of DescribePermissions
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribePermissions
, describePermissions_iamUserArn
- The user's IAM ARN. This can also be a federated user's ARN. For more
information about IAM ARNs, see
Using Identifiers.
DescribePermissions
, describePermissions_stackId
- The stack ID.
data DescribePermissionsResponse Source #
Contains the response to a DescribePermissions
request.
See: newDescribePermissionsResponse
smart constructor.
Constructors
DescribePermissionsResponse' (Maybe [Permission]) Int |
Instances
newDescribePermissionsResponse Source #
Create a value of DescribePermissionsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:permissions:DescribePermissionsResponse'
, describePermissionsResponse_permissions
- An array of Permission
objects that describe the stack permissions.
- If the request object contains only a stack ID, the array contains a
Permission
object with permissions for each of the stack IAM ARNs. - If the request object contains only an IAM ARN, the array contains a
Permission
object with permissions for each of the user's stack IDs. - If the request contains a stack ID and an IAM ARN, the array
contains a single
Permission
object with permissions for the specified stack and IAM ARN.
$sel:httpStatus:DescribePermissionsResponse'
, describePermissionsResponse_httpStatus
- The response's http status code.
DescribeRaidArrays
data DescribeRaidArrays Source #
See: newDescribeRaidArrays
smart constructor.
Instances
newDescribeRaidArrays :: DescribeRaidArrays Source #
Create a value of DescribeRaidArrays
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRaidArrays
, describeRaidArrays_instanceId
- The instance ID. If you use this parameter, DescribeRaidArrays
returns
descriptions of the RAID arrays associated with the specified instance.
$sel:raidArrayIds:DescribeRaidArrays'
, describeRaidArrays_raidArrayIds
- An array of RAID array IDs. If you use this parameter,
DescribeRaidArrays
returns descriptions of the specified arrays.
Otherwise, it returns a description of every array.
DescribeRaidArrays
, describeRaidArrays_stackId
- The stack ID.
data DescribeRaidArraysResponse Source #
Contains the response to a DescribeRaidArrays
request.
See: newDescribeRaidArraysResponse
smart constructor.
Constructors
DescribeRaidArraysResponse' (Maybe [RaidArray]) Int |
Instances
newDescribeRaidArraysResponse Source #
Create a value of DescribeRaidArraysResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:raidArrays:DescribeRaidArraysResponse'
, describeRaidArraysResponse_raidArrays
- A RaidArrays
object that describes the specified RAID arrays.
$sel:httpStatus:DescribeRaidArraysResponse'
, describeRaidArraysResponse_httpStatus
- The response's http status code.
DescribeRdsDbInstances
data DescribeRdsDbInstances Source #
See: newDescribeRdsDbInstances
smart constructor.
Constructors
DescribeRdsDbInstances' (Maybe [Text]) Text |
Instances
newDescribeRdsDbInstances Source #
Arguments
:: Text | |
-> DescribeRdsDbInstances |
Create a value of DescribeRdsDbInstances
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rdsDbInstanceArns:DescribeRdsDbInstances'
, describeRdsDbInstances_rdsDbInstanceArns
- An array containing the ARNs of the instances to be described.
DescribeRdsDbInstances
, describeRdsDbInstances_stackId
- The ID of the stack with which the instances are registered. The
operation returns descriptions of all registered Amazon RDS instances.
data DescribeRdsDbInstancesResponse Source #
Contains the response to a DescribeRdsDbInstances
request.
See: newDescribeRdsDbInstancesResponse
smart constructor.
Constructors
DescribeRdsDbInstancesResponse' (Maybe [RdsDbInstance]) Int |
Instances
newDescribeRdsDbInstancesResponse Source #
Create a value of DescribeRdsDbInstancesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:rdsDbInstances:DescribeRdsDbInstancesResponse'
, describeRdsDbInstancesResponse_rdsDbInstances
- An a array of RdsDbInstance
objects that describe the instances.
$sel:httpStatus:DescribeRdsDbInstancesResponse'
, describeRdsDbInstancesResponse_httpStatus
- The response's http status code.
DescribeServiceErrors
data DescribeServiceErrors Source #
See: newDescribeServiceErrors
smart constructor.
Instances
newDescribeServiceErrors :: DescribeServiceErrors Source #
Create a value of DescribeServiceErrors
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeServiceErrors
, describeServiceErrors_instanceId
- The instance ID. If you use this parameter, DescribeServiceErrors
returns descriptions of the errors associated with the specified
instance.
$sel:serviceErrorIds:DescribeServiceErrors'
, describeServiceErrors_serviceErrorIds
- An array of service error IDs. If you use this parameter,
DescribeServiceErrors
returns descriptions of the specified errors.
Otherwise, it returns a description of every error.
DescribeServiceErrors
, describeServiceErrors_stackId
- The stack ID. If you use this parameter, DescribeServiceErrors
returns
descriptions of the errors associated with the specified stack.
data DescribeServiceErrorsResponse Source #
Contains the response to a DescribeServiceErrors
request.
See: newDescribeServiceErrorsResponse
smart constructor.
Constructors
DescribeServiceErrorsResponse' (Maybe [ServiceError]) Int |
Instances
newDescribeServiceErrorsResponse Source #
Create a value of DescribeServiceErrorsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:serviceErrors:DescribeServiceErrorsResponse'
, describeServiceErrorsResponse_serviceErrors
- An array of ServiceError
objects that describe the specified service
errors.
$sel:httpStatus:DescribeServiceErrorsResponse'
, describeServiceErrorsResponse_httpStatus
- The response's http status code.
DescribeStackProvisioningParameters
data DescribeStackProvisioningParameters Source #
See: newDescribeStackProvisioningParameters
smart constructor.
Constructors
DescribeStackProvisioningParameters' Text |
Instances
newDescribeStackProvisioningParameters Source #
Create a value of DescribeStackProvisioningParameters
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStackProvisioningParameters
, describeStackProvisioningParameters_stackId
- The stack ID.
data DescribeStackProvisioningParametersResponse Source #
Contains the response to a DescribeStackProvisioningParameters
request.
See: newDescribeStackProvisioningParametersResponse
smart constructor.
Constructors
DescribeStackProvisioningParametersResponse' (Maybe Text) (Maybe (HashMap Text Text)) Int |
Instances
newDescribeStackProvisioningParametersResponse Source #
Arguments
:: Int |
|
-> DescribeStackProvisioningParametersResponse |
Create a value of DescribeStackProvisioningParametersResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentInstallerUrl:DescribeStackProvisioningParametersResponse'
, describeStackProvisioningParametersResponse_agentInstallerUrl
- The AWS OpsWorks Stacks agent installer's URL.
$sel:parameters:DescribeStackProvisioningParametersResponse'
, describeStackProvisioningParametersResponse_parameters
- An embedded object that contains the provisioning parameters.
$sel:httpStatus:DescribeStackProvisioningParametersResponse'
, describeStackProvisioningParametersResponse_httpStatus
- The response's http status code.
DescribeStackSummary
data DescribeStackSummary Source #
See: newDescribeStackSummary
smart constructor.
Constructors
DescribeStackSummary' Text |
Instances
newDescribeStackSummary Source #
Arguments
:: Text | |
-> DescribeStackSummary |
Create a value of DescribeStackSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeStackSummary
, describeStackSummary_stackId
- The stack ID.
data DescribeStackSummaryResponse Source #
Contains the response to a DescribeStackSummary
request.
See: newDescribeStackSummaryResponse
smart constructor.
Constructors
DescribeStackSummaryResponse' (Maybe StackSummary) Int |
Instances
newDescribeStackSummaryResponse Source #
Create a value of DescribeStackSummaryResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackSummary:DescribeStackSummaryResponse'
, describeStackSummaryResponse_stackSummary
- A StackSummary
object that contains the results.
$sel:httpStatus:DescribeStackSummaryResponse'
, describeStackSummaryResponse_httpStatus
- The response's http status code.
DescribeStacks
data DescribeStacks Source #
See: newDescribeStacks
smart constructor.
Constructors
DescribeStacks' (Maybe [Text]) |
Instances
newDescribeStacks :: DescribeStacks Source #
Create a value of DescribeStacks
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stackIds:DescribeStacks'
, describeStacks_stackIds
- An array of stack IDs that specify the stacks to be described. If you
omit this parameter, DescribeStacks
returns a description of every
stack.
data DescribeStacksResponse Source #
Contains the response to a DescribeStacks
request.
See: newDescribeStacksResponse
smart constructor.
Constructors
DescribeStacksResponse' (Maybe [Stack]) Int |
Instances
newDescribeStacksResponse Source #
Create a value of DescribeStacksResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:stacks:DescribeStacksResponse'
, describeStacksResponse_stacks
- An array of Stack
objects that describe the stacks.
$sel:httpStatus:DescribeStacksResponse'
, describeStacksResponse_httpStatus
- The response's http status code.
DescribeTimeBasedAutoScaling
data DescribeTimeBasedAutoScaling Source #
See: newDescribeTimeBasedAutoScaling
smart constructor.
Constructors
DescribeTimeBasedAutoScaling' [Text] |
Instances
newDescribeTimeBasedAutoScaling :: DescribeTimeBasedAutoScaling Source #
Create a value of DescribeTimeBasedAutoScaling
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeTimeBasedAutoScaling
, describeTimeBasedAutoScaling_instanceIds
- An array of instance IDs.
data DescribeTimeBasedAutoScalingResponse Source #
Contains the response to a DescribeTimeBasedAutoScaling
request.
See: newDescribeTimeBasedAutoScalingResponse
smart constructor.
Instances
newDescribeTimeBasedAutoScalingResponse Source #
Arguments
:: Int | |
-> DescribeTimeBasedAutoScalingResponse |
Create a value of DescribeTimeBasedAutoScalingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:timeBasedAutoScalingConfigurations:DescribeTimeBasedAutoScalingResponse'
, describeTimeBasedAutoScalingResponse_timeBasedAutoScalingConfigurations
- An array of TimeBasedAutoScalingConfiguration
objects that describe
the configuration for the specified instances.
$sel:httpStatus:DescribeTimeBasedAutoScalingResponse'
, describeTimeBasedAutoScalingResponse_httpStatus
- The response's http status code.
DescribeUserProfiles
data DescribeUserProfiles Source #
See: newDescribeUserProfiles
smart constructor.
Constructors
DescribeUserProfiles' (Maybe [Text]) |
Instances
newDescribeUserProfiles :: DescribeUserProfiles Source #
Create a value of DescribeUserProfiles
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamUserArns:DescribeUserProfiles'
, describeUserProfiles_iamUserArns
- An array of IAM or federated user ARNs that identify the users to be
described.
data DescribeUserProfilesResponse Source #
Contains the response to a DescribeUserProfiles
request.
See: newDescribeUserProfilesResponse
smart constructor.
Constructors
DescribeUserProfilesResponse' (Maybe [UserProfile]) Int |
Instances
newDescribeUserProfilesResponse Source #
Create a value of DescribeUserProfilesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:userProfiles:DescribeUserProfilesResponse'
, describeUserProfilesResponse_userProfiles
- A Users
object that describes the specified users.
$sel:httpStatus:DescribeUserProfilesResponse'
, describeUserProfilesResponse_httpStatus
- The response's http status code.
DescribeVolumes
data DescribeVolumes Source #
See: newDescribeVolumes
smart constructor.
Instances
newDescribeVolumes :: DescribeVolumes Source #
Create a value of DescribeVolumes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeVolumes
, describeVolumes_instanceId
- The instance ID. If you use this parameter, DescribeVolumes
returns
descriptions of the volumes associated with the specified instance.
DescribeVolumes
, describeVolumes_raidArrayId
- The RAID array ID. If you use this parameter, DescribeVolumes
returns
descriptions of the volumes associated with the specified RAID array.
DescribeVolumes
, describeVolumes_stackId
- A stack ID. The action describes the stack's registered Amazon EBS
volumes.
$sel:volumeIds:DescribeVolumes'
, describeVolumes_volumeIds
- Am array of volume IDs. If you use this parameter, DescribeVolumes
returns descriptions of the specified volumes. Otherwise, it returns a
description of every volume.
data DescribeVolumesResponse Source #
Contains the response to a DescribeVolumes
request.
See: newDescribeVolumesResponse
smart constructor.
Constructors
DescribeVolumesResponse' (Maybe [Volume]) Int |
Instances
newDescribeVolumesResponse Source #
Create a value of DescribeVolumesResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:volumes:DescribeVolumesResponse'
, describeVolumesResponse_volumes
- An array of volume IDs.
$sel:httpStatus:DescribeVolumesResponse'
, describeVolumesResponse_httpStatus
- The response's http status code.
DetachElasticLoadBalancer
data DetachElasticLoadBalancer Source #
See: newDetachElasticLoadBalancer
smart constructor.
Constructors
DetachElasticLoadBalancer' Text Text |
Instances
newDetachElasticLoadBalancer Source #
Arguments
:: Text | |
-> Text | |
-> DetachElasticLoadBalancer |
Create a value of DetachElasticLoadBalancer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DetachElasticLoadBalancer
, detachElasticLoadBalancer_elasticLoadBalancerName
- The Elastic Load Balancing instance's name.
DetachElasticLoadBalancer
, detachElasticLoadBalancer_layerId
- The ID of the layer that the Elastic Load Balancing instance is attached
to.
data DetachElasticLoadBalancerResponse Source #
See: newDetachElasticLoadBalancerResponse
smart constructor.
Constructors
DetachElasticLoadBalancerResponse' | |
Instances
Generic DetachElasticLoadBalancerResponse Source # | |
Defined in Amazonka.OpsWorks.DetachElasticLoadBalancer Associated Types type Rep DetachElasticLoadBalancerResponse :: Type -> Type # | |
Read DetachElasticLoadBalancerResponse Source # | |
Show DetachElasticLoadBalancerResponse Source # | |
Defined in Amazonka.OpsWorks.DetachElasticLoadBalancer Methods showsPrec :: Int -> DetachElasticLoadBalancerResponse -> ShowS # | |
NFData DetachElasticLoadBalancerResponse Source # | |
Defined in Amazonka.OpsWorks.DetachElasticLoadBalancer Methods rnf :: DetachElasticLoadBalancerResponse -> () # | |
Eq DetachElasticLoadBalancerResponse Source # | |
type Rep DetachElasticLoadBalancerResponse Source # | |
Defined in Amazonka.OpsWorks.DetachElasticLoadBalancer |
newDetachElasticLoadBalancerResponse :: DetachElasticLoadBalancerResponse Source #
Create a value of DetachElasticLoadBalancerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
DisassociateElasticIp
data DisassociateElasticIp Source #
See: newDisassociateElasticIp
smart constructor.
Constructors
DisassociateElasticIp' Text |
Instances
newDisassociateElasticIp Source #
Arguments
:: Text | |
-> DisassociateElasticIp |
Create a value of DisassociateElasticIp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DisassociateElasticIp
, disassociateElasticIp_elasticIp
- The Elastic IP address.
data DisassociateElasticIpResponse Source #
See: newDisassociateElasticIpResponse
smart constructor.
Constructors
DisassociateElasticIpResponse' | |
Instances
Generic DisassociateElasticIpResponse Source # | |
Defined in Amazonka.OpsWorks.DisassociateElasticIp Associated Types type Rep DisassociateElasticIpResponse :: Type -> Type # | |
Read DisassociateElasticIpResponse Source # | |
Show DisassociateElasticIpResponse Source # | |
Defined in Amazonka.OpsWorks.DisassociateElasticIp Methods showsPrec :: Int -> DisassociateElasticIpResponse -> ShowS # show :: DisassociateElasticIpResponse -> String # showList :: [DisassociateElasticIpResponse] -> ShowS # | |
NFData DisassociateElasticIpResponse Source # | |
Defined in Amazonka.OpsWorks.DisassociateElasticIp Methods rnf :: DisassociateElasticIpResponse -> () # | |
Eq DisassociateElasticIpResponse Source # | |
Defined in Amazonka.OpsWorks.DisassociateElasticIp | |
type Rep DisassociateElasticIpResponse Source # | |
Defined in Amazonka.OpsWorks.DisassociateElasticIp |
newDisassociateElasticIpResponse :: DisassociateElasticIpResponse Source #
Create a value of DisassociateElasticIpResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
GetHostnameSuggestion
data GetHostnameSuggestion Source #
See: newGetHostnameSuggestion
smart constructor.
Constructors
GetHostnameSuggestion' Text |
Instances
newGetHostnameSuggestion Source #
Arguments
:: Text | |
-> GetHostnameSuggestion |
Create a value of GetHostnameSuggestion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetHostnameSuggestion
, getHostnameSuggestion_layerId
- The layer ID.
data GetHostnameSuggestionResponse Source #
Contains the response to a GetHostnameSuggestion
request.
See: newGetHostnameSuggestionResponse
smart constructor.
Instances
newGetHostnameSuggestionResponse Source #
Create a value of GetHostnameSuggestionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GetHostnameSuggestionResponse
, getHostnameSuggestionResponse_hostname
- The generated host name.
GetHostnameSuggestion
, getHostnameSuggestionResponse_layerId
- The layer ID.
$sel:httpStatus:GetHostnameSuggestionResponse'
, getHostnameSuggestionResponse_httpStatus
- The response's http status code.
GrantAccess
data GrantAccess Source #
See: newGrantAccess
smart constructor.
Constructors
GrantAccess' (Maybe Natural) Text |
Instances
Arguments
:: Text | |
-> GrantAccess |
Create a value of GrantAccess
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
GrantAccess
, grantAccess_validForInMinutes
- The length of time (in minutes) that the grant is valid. When the grant
expires at the end of this period, the user will no longer be able to
use the credentials to log in. If the user is logged in at the time, he
or she automatically will be logged out.
GrantAccess
, grantAccess_instanceId
- The instance's AWS OpsWorks Stacks ID.
data GrantAccessResponse Source #
Contains the response to a GrantAccess
request.
See: newGrantAccessResponse
smart constructor.
Constructors
GrantAccessResponse' (Maybe TemporaryCredential) Int |
Instances
newGrantAccessResponse Source #
Arguments
:: Int | |
-> GrantAccessResponse |
Create a value of GrantAccessResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:temporaryCredential:GrantAccessResponse'
, grantAccessResponse_temporaryCredential
- A TemporaryCredential
object that contains the data needed to log in
to the instance by RDP clients, such as the Microsoft Remote Desktop
Connection.
$sel:httpStatus:GrantAccessResponse'
, grantAccessResponse_httpStatus
- The response's http status code.
ListTags
See: newListTags
smart constructor.
Instances
Create a value of ListTags
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:maxResults:ListTags'
, listTags_maxResults
- Do not use. A validation exception occurs if you add a MaxResults
parameter to a ListTagsRequest
call.
ListTags
, listTags_nextToken
- Do not use. A validation exception occurs if you add a NextToken
parameter to a ListTagsRequest
call.
$sel:resourceArn:ListTags'
, listTags_resourceArn
- The stack or layer's Amazon Resource Number (ARN).
data ListTagsResponse Source #
Contains the response to a ListTags
request.
See: newListTagsResponse
smart constructor.
Instances
Arguments
:: Int | |
-> ListTagsResponse |
Create a value of ListTagsResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
ListTags
, listTagsResponse_nextToken
- If a paginated request does not return all of the remaining results,
this parameter is set to a token that you can assign to the request
object's NextToken
parameter to get the next set of results. If the
previous paginated request returned all of the remaining results, this
parameter is set to null
.
$sel:tags:ListTagsResponse'
, listTagsResponse_tags
- A set of key-value pairs that contain tag keys and tag values that are
attached to a stack or layer.
$sel:httpStatus:ListTagsResponse'
, listTagsResponse_httpStatus
- The response's http status code.
RebootInstance
data RebootInstance Source #
See: newRebootInstance
smart constructor.
Constructors
RebootInstance' Text |
Instances
Arguments
:: Text | |
-> RebootInstance |
Create a value of RebootInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RebootInstance
, rebootInstance_instanceId
- The instance ID.
data RebootInstanceResponse Source #
See: newRebootInstanceResponse
smart constructor.
Constructors
RebootInstanceResponse' | |
Instances
Generic RebootInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RebootInstance Associated Types type Rep RebootInstanceResponse :: Type -> Type # Methods from :: RebootInstanceResponse -> Rep RebootInstanceResponse x # to :: Rep RebootInstanceResponse x -> RebootInstanceResponse # | |
Read RebootInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RebootInstance | |
Show RebootInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RebootInstance Methods showsPrec :: Int -> RebootInstanceResponse -> ShowS # show :: RebootInstanceResponse -> String # showList :: [RebootInstanceResponse] -> ShowS # | |
NFData RebootInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RebootInstance Methods rnf :: RebootInstanceResponse -> () # | |
Eq RebootInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RebootInstance Methods (==) :: RebootInstanceResponse -> RebootInstanceResponse -> Bool # (/=) :: RebootInstanceResponse -> RebootInstanceResponse -> Bool # | |
type Rep RebootInstanceResponse Source # | |
newRebootInstanceResponse :: RebootInstanceResponse Source #
Create a value of RebootInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RegisterEcsCluster
data RegisterEcsCluster Source #
See: newRegisterEcsCluster
smart constructor.
Constructors
RegisterEcsCluster' Text Text |
Instances
newRegisterEcsCluster Source #
Arguments
:: Text | |
-> Text | |
-> RegisterEcsCluster |
Create a value of RegisterEcsCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterEcsCluster
, registerEcsCluster_ecsClusterArn
- The cluster's ARN.
RegisterEcsCluster
, registerEcsCluster_stackId
- The stack ID.
data RegisterEcsClusterResponse Source #
Contains the response to a RegisterEcsCluster
request.
See: newRegisterEcsClusterResponse
smart constructor.
Constructors
RegisterEcsClusterResponse' (Maybe Text) Int |
Instances
newRegisterEcsClusterResponse Source #
Create a value of RegisterEcsClusterResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterEcsCluster
, registerEcsClusterResponse_ecsClusterArn
- The cluster's ARN.
$sel:httpStatus:RegisterEcsClusterResponse'
, registerEcsClusterResponse_httpStatus
- The response's http status code.
RegisterElasticIp
data RegisterElasticIp Source #
See: newRegisterElasticIp
smart constructor.
Constructors
RegisterElasticIp' Text Text |
Instances
Arguments
:: Text | |
-> Text | |
-> RegisterElasticIp |
Create a value of RegisterElasticIp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterElasticIp
, registerElasticIp_elasticIp
- The Elastic IP address.
RegisterElasticIp
, registerElasticIp_stackId
- The stack ID.
data RegisterElasticIpResponse Source #
Contains the response to a RegisterElasticIp
request.
See: newRegisterElasticIpResponse
smart constructor.
Constructors
RegisterElasticIpResponse' (Maybe Text) Int |
Instances
newRegisterElasticIpResponse Source #
Create a value of RegisterElasticIpResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterElasticIp
, registerElasticIpResponse_elasticIp
- The Elastic IP address.
$sel:httpStatus:RegisterElasticIpResponse'
, registerElasticIpResponse_httpStatus
- The response's http status code.
RegisterInstance
data RegisterInstance Source #
See: newRegisterInstance
smart constructor.
Constructors
RegisterInstance' (Maybe Text) (Maybe InstanceIdentity) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> RegisterInstance |
Create a value of RegisterInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterInstance
, registerInstance_hostname
- The instance's hostname.
$sel:instanceIdentity:RegisterInstance'
, registerInstance_instanceIdentity
- An InstanceIdentity object that contains the instance's identity.
RegisterInstance
, registerInstance_privateIp
- The instance's private IP address.
RegisterInstance
, registerInstance_publicIp
- The instance's public IP address.
$sel:rsaPublicKey:RegisterInstance'
, registerInstance_rsaPublicKey
- The instances public RSA key. This key is used to encrypt communication
between the instance and the service.
$sel:rsaPublicKeyFingerprint:RegisterInstance'
, registerInstance_rsaPublicKeyFingerprint
- The instances public RSA key fingerprint.
RegisterInstance
, registerInstance_stackId
- The ID of the stack that the instance is to be registered with.
data RegisterInstanceResponse Source #
Contains the response to a RegisterInstanceResult
request.
See: newRegisterInstanceResponse
smart constructor.
Constructors
RegisterInstanceResponse' (Maybe Text) Int |
Instances
newRegisterInstanceResponse Source #
Create a value of RegisterInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterInstanceResponse
, registerInstanceResponse_instanceId
- The registered instance's AWS OpsWorks Stacks ID.
$sel:httpStatus:RegisterInstanceResponse'
, registerInstanceResponse_httpStatus
- The response's http status code.
RegisterRdsDbInstance
data RegisterRdsDbInstance Source #
See: newRegisterRdsDbInstance
smart constructor.
Constructors
RegisterRdsDbInstance' Text Text Text Text |
Instances
newRegisterRdsDbInstance Source #
Arguments
:: Text | |
-> Text | |
-> Text | |
-> Text | |
-> RegisterRdsDbInstance |
Create a value of RegisterRdsDbInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterRdsDbInstance
, registerRdsDbInstance_stackId
- The stack ID.
RegisterRdsDbInstance
, registerRdsDbInstance_rdsDbInstanceArn
- The Amazon RDS instance's ARN.
RegisterRdsDbInstance
, registerRdsDbInstance_dbUser
- The database's master user name.
RegisterRdsDbInstance
, registerRdsDbInstance_dbPassword
- The database password.
data RegisterRdsDbInstanceResponse Source #
See: newRegisterRdsDbInstanceResponse
smart constructor.
Constructors
RegisterRdsDbInstanceResponse' | |
Instances
Generic RegisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RegisterRdsDbInstance Associated Types type Rep RegisterRdsDbInstanceResponse :: Type -> Type # | |
Read RegisterRdsDbInstanceResponse Source # | |
Show RegisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RegisterRdsDbInstance Methods showsPrec :: Int -> RegisterRdsDbInstanceResponse -> ShowS # show :: RegisterRdsDbInstanceResponse -> String # showList :: [RegisterRdsDbInstanceResponse] -> ShowS # | |
NFData RegisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RegisterRdsDbInstance Methods rnf :: RegisterRdsDbInstanceResponse -> () # | |
Eq RegisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RegisterRdsDbInstance | |
type Rep RegisterRdsDbInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.RegisterRdsDbInstance |
newRegisterRdsDbInstanceResponse :: RegisterRdsDbInstanceResponse Source #
Create a value of RegisterRdsDbInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
RegisterVolume
data RegisterVolume Source #
See: newRegisterVolume
smart constructor.
Constructors
RegisterVolume' (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> RegisterVolume |
Create a value of RegisterVolume
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterVolume
, registerVolume_ec2VolumeId
- The Amazon EBS volume ID.
RegisterVolume
, registerVolume_stackId
- The stack ID.
data RegisterVolumeResponse Source #
Contains the response to a RegisterVolume
request.
See: newRegisterVolumeResponse
smart constructor.
Constructors
RegisterVolumeResponse' (Maybe Text) Int |
Instances
newRegisterVolumeResponse Source #
Create a value of RegisterVolumeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
RegisterVolumeResponse
, registerVolumeResponse_volumeId
- The volume ID.
$sel:httpStatus:RegisterVolumeResponse'
, registerVolumeResponse_httpStatus
- The response's http status code.
SetLoadBasedAutoScaling
data SetLoadBasedAutoScaling Source #
See: newSetLoadBasedAutoScaling
smart constructor.
Constructors
SetLoadBasedAutoScaling' (Maybe AutoScalingThresholds) (Maybe Bool) (Maybe AutoScalingThresholds) Text |
Instances
newSetLoadBasedAutoScaling Source #
Arguments
:: Text | |
-> SetLoadBasedAutoScaling |
Create a value of SetLoadBasedAutoScaling
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SetLoadBasedAutoScaling
, setLoadBasedAutoScaling_downScaling
- An AutoScalingThresholds
object with the downscaling threshold
configuration. If the load falls below these thresholds for a specified
amount of time, AWS OpsWorks Stacks stops a specified number of
instances.
SetLoadBasedAutoScaling
, setLoadBasedAutoScaling_enable
- Enables load-based auto scaling for the layer.
SetLoadBasedAutoScaling
, setLoadBasedAutoScaling_upScaling
- An AutoScalingThresholds
object with the upscaling threshold
configuration. If the load exceeds these thresholds for a specified
amount of time, AWS OpsWorks Stacks starts a specified number of
instances.
SetLoadBasedAutoScaling
, setLoadBasedAutoScaling_layerId
- The layer ID.
data SetLoadBasedAutoScalingResponse Source #
See: newSetLoadBasedAutoScalingResponse
smart constructor.
Constructors
SetLoadBasedAutoScalingResponse' | |
Instances
Generic SetLoadBasedAutoScalingResponse Source # | |
Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Associated Types type Rep SetLoadBasedAutoScalingResponse :: Type -> Type # | |
Read SetLoadBasedAutoScalingResponse Source # | |
Show SetLoadBasedAutoScalingResponse Source # | |
Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods showsPrec :: Int -> SetLoadBasedAutoScalingResponse -> ShowS # | |
NFData SetLoadBasedAutoScalingResponse Source # | |
Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling Methods rnf :: SetLoadBasedAutoScalingResponse -> () # | |
Eq SetLoadBasedAutoScalingResponse Source # | |
type Rep SetLoadBasedAutoScalingResponse Source # | |
Defined in Amazonka.OpsWorks.SetLoadBasedAutoScaling |
newSetLoadBasedAutoScalingResponse :: SetLoadBasedAutoScalingResponse Source #
Create a value of SetLoadBasedAutoScalingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetPermission
data SetPermission Source #
See: newSetPermission
smart constructor.
Instances
Arguments
:: Text | |
-> Text | |
-> SetPermission |
Create a value of SetPermission
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SetPermission
, setPermission_allowSsh
- The user is allowed to use SSH to communicate with the instance.
SetPermission
, setPermission_allowSudo
- The user is allowed to use sudo to elevate privileges.
SetPermission
, setPermission_level
- The user's permission level, which must be set to one of the following
strings. You cannot set your own permissions level.
deny
show
deploy
manage
iam_only
For more information about the permissions associated with these levels, see Managing User Permissions.
SetPermission
, setPermission_stackId
- The stack ID.
SetPermission
, setPermission_iamUserArn
- The user's IAM ARN. This can also be a federated user's ARN.
data SetPermissionResponse Source #
See: newSetPermissionResponse
smart constructor.
Constructors
SetPermissionResponse' | |
Instances
newSetPermissionResponse :: SetPermissionResponse Source #
Create a value of SetPermissionResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
SetTimeBasedAutoScaling
data SetTimeBasedAutoScaling Source #
See: newSetTimeBasedAutoScaling
smart constructor.
Constructors
SetTimeBasedAutoScaling' (Maybe WeeklyAutoScalingSchedule) Text |
Instances
newSetTimeBasedAutoScaling Source #
Arguments
:: Text | |
-> SetTimeBasedAutoScaling |
Create a value of SetTimeBasedAutoScaling
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
SetTimeBasedAutoScaling
, setTimeBasedAutoScaling_autoScalingSchedule
- An AutoScalingSchedule
with the instance schedule.
SetTimeBasedAutoScaling
, setTimeBasedAutoScaling_instanceId
- The instance ID.
data SetTimeBasedAutoScalingResponse Source #
See: newSetTimeBasedAutoScalingResponse
smart constructor.
Constructors
SetTimeBasedAutoScalingResponse' | |
Instances
Generic SetTimeBasedAutoScalingResponse Source # | |
Defined in Amazonka.OpsWorks.SetTimeBasedAutoScaling Associated Types type Rep SetTimeBasedAutoScalingResponse :: Type -> Type # | |
Read SetTimeBasedAutoScalingResponse Source # | |
Show SetTimeBasedAutoScalingResponse Source # | |
Defined in Amazonka.OpsWorks.SetTimeBasedAutoScaling Methods showsPrec :: Int -> SetTimeBasedAutoScalingResponse -> ShowS # | |
NFData SetTimeBasedAutoScalingResponse Source # | |
Defined in Amazonka.OpsWorks.SetTimeBasedAutoScaling Methods rnf :: SetTimeBasedAutoScalingResponse -> () # | |
Eq SetTimeBasedAutoScalingResponse Source # | |
type Rep SetTimeBasedAutoScalingResponse Source # | |
Defined in Amazonka.OpsWorks.SetTimeBasedAutoScaling |
newSetTimeBasedAutoScalingResponse :: SetTimeBasedAutoScalingResponse Source #
Create a value of SetTimeBasedAutoScalingResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartInstance
data StartInstance Source #
See: newStartInstance
smart constructor.
Constructors
StartInstance' Text |
Instances
Arguments
:: Text | |
-> StartInstance |
Create a value of StartInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartInstance
, startInstance_instanceId
- The instance ID.
data StartInstanceResponse Source #
See: newStartInstanceResponse
smart constructor.
Constructors
StartInstanceResponse' | |
Instances
newStartInstanceResponse :: StartInstanceResponse Source #
Create a value of StartInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StartStack
data StartStack Source #
See: newStartStack
smart constructor.
Constructors
StartStack' Text |
Instances
Arguments
:: Text | |
-> StartStack |
Create a value of StartStack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StartStack
, startStack_stackId
- The stack ID.
data StartStackResponse Source #
See: newStartStackResponse
smart constructor.
Constructors
StartStackResponse' | |
Instances
Generic StartStackResponse Source # | |
Defined in Amazonka.OpsWorks.StartStack Associated Types type Rep StartStackResponse :: Type -> Type # Methods from :: StartStackResponse -> Rep StartStackResponse x # to :: Rep StartStackResponse x -> StartStackResponse # | |
Read StartStackResponse Source # | |
Defined in Amazonka.OpsWorks.StartStack Methods readsPrec :: Int -> ReadS StartStackResponse # readList :: ReadS [StartStackResponse] # | |
Show StartStackResponse Source # | |
Defined in Amazonka.OpsWorks.StartStack Methods showsPrec :: Int -> StartStackResponse -> ShowS # show :: StartStackResponse -> String # showList :: [StartStackResponse] -> ShowS # | |
NFData StartStackResponse Source # | |
Defined in Amazonka.OpsWorks.StartStack Methods rnf :: StartStackResponse -> () # | |
Eq StartStackResponse Source # | |
Defined in Amazonka.OpsWorks.StartStack Methods (==) :: StartStackResponse -> StartStackResponse -> Bool # (/=) :: StartStackResponse -> StartStackResponse -> Bool # | |
type Rep StartStackResponse Source # | |
newStartStackResponse :: StartStackResponse Source #
Create a value of StartStackResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopInstance
data StopInstance Source #
See: newStopInstance
smart constructor.
Constructors
StopInstance' (Maybe Bool) Text |
Instances
Arguments
:: Text | |
-> StopInstance |
Create a value of StopInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:force:StopInstance'
, stopInstance_force
- Specifies whether to force an instance to stop. If the instance's root
device type is ebs
, or EBS-backed, adding the Force
parameter to the
StopInstances
API call disassociates the AWS OpsWorks Stacks instance
from EC2, and forces deletion of only the OpsWorks Stacks instance.
You must also delete the formerly-associated instance in EC2 after
troubleshooting and replacing the AWS OpsWorks Stacks instance with a
new one.
StopInstance
, stopInstance_instanceId
- The instance ID.
data StopInstanceResponse Source #
See: newStopInstanceResponse
smart constructor.
Constructors
StopInstanceResponse' | |
Instances
newStopInstanceResponse :: StopInstanceResponse Source #
Create a value of StopInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
StopStack
See: newStopStack
smart constructor.
Constructors
StopStack' Text |
Instances
Create a value of StopStack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
StopStack
, stopStack_stackId
- The stack ID.
data StopStackResponse Source #
See: newStopStackResponse
smart constructor.
Constructors
StopStackResponse' | |
Instances
Generic StopStackResponse Source # | |
Defined in Amazonka.OpsWorks.StopStack Associated Types type Rep StopStackResponse :: Type -> Type # Methods from :: StopStackResponse -> Rep StopStackResponse x # to :: Rep StopStackResponse x -> StopStackResponse # | |
Read StopStackResponse Source # | |
Defined in Amazonka.OpsWorks.StopStack Methods readsPrec :: Int -> ReadS StopStackResponse # readList :: ReadS [StopStackResponse] # | |
Show StopStackResponse Source # | |
Defined in Amazonka.OpsWorks.StopStack Methods showsPrec :: Int -> StopStackResponse -> ShowS # show :: StopStackResponse -> String # showList :: [StopStackResponse] -> ShowS # | |
NFData StopStackResponse Source # | |
Defined in Amazonka.OpsWorks.StopStack Methods rnf :: StopStackResponse -> () # | |
Eq StopStackResponse Source # | |
Defined in Amazonka.OpsWorks.StopStack Methods (==) :: StopStackResponse -> StopStackResponse -> Bool # (/=) :: StopStackResponse -> StopStackResponse -> Bool # | |
type Rep StopStackResponse Source # | |
newStopStackResponse :: StopStackResponse Source #
Create a value of StopStackResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
TagResource
data TagResource Source #
See: newTagResource
smart constructor.
Constructors
TagResource' Text (HashMap Text Text) |
Instances
Arguments
:: Text | |
-> TagResource |
Create a value of TagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:TagResource'
, tagResource_resourceArn
- The stack or layer's Amazon Resource Number (ARN).
$sel:tags:TagResource'
, tagResource_tags
- A map that contains tag keys and tag values that are attached to a stack
or layer.
- The key cannot be empty.
- The key can be a maximum of 127 characters, and can contain only
Unicode letters, numbers, or separators, or the following special
characters:
+ - = . _ : /
- The value can be a maximum 255 characters, and contain only Unicode
letters, numbers, or separators, or the following special
characters:
+ - = . _ : /
- Leading and trailing white spaces are trimmed from both the key and value.
- A maximum of 40 tags is allowed for any resource.
data TagResourceResponse Source #
See: newTagResourceResponse
smart constructor.
Constructors
TagResourceResponse' | |
Instances
newTagResourceResponse :: TagResourceResponse Source #
Create a value of TagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UnassignInstance
data UnassignInstance Source #
See: newUnassignInstance
smart constructor.
Constructors
UnassignInstance' Text |
Instances
Arguments
:: Text | |
-> UnassignInstance |
Create a value of UnassignInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UnassignInstance
, unassignInstance_instanceId
- The instance ID.
data UnassignInstanceResponse Source #
See: newUnassignInstanceResponse
smart constructor.
Constructors
UnassignInstanceResponse' | |
Instances
newUnassignInstanceResponse :: UnassignInstanceResponse Source #
Create a value of UnassignInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UnassignVolume
data UnassignVolume Source #
See: newUnassignVolume
smart constructor.
Constructors
UnassignVolume' Text |
Instances
Arguments
:: Text | |
-> UnassignVolume |
Create a value of UnassignVolume
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UnassignVolume
, unassignVolume_volumeId
- The volume ID.
data UnassignVolumeResponse Source #
See: newUnassignVolumeResponse
smart constructor.
Constructors
UnassignVolumeResponse' | |
Instances
Generic UnassignVolumeResponse Source # | |
Defined in Amazonka.OpsWorks.UnassignVolume Associated Types type Rep UnassignVolumeResponse :: Type -> Type # Methods from :: UnassignVolumeResponse -> Rep UnassignVolumeResponse x # to :: Rep UnassignVolumeResponse x -> UnassignVolumeResponse # | |
Read UnassignVolumeResponse Source # | |
Defined in Amazonka.OpsWorks.UnassignVolume | |
Show UnassignVolumeResponse Source # | |
Defined in Amazonka.OpsWorks.UnassignVolume Methods showsPrec :: Int -> UnassignVolumeResponse -> ShowS # show :: UnassignVolumeResponse -> String # showList :: [UnassignVolumeResponse] -> ShowS # | |
NFData UnassignVolumeResponse Source # | |
Defined in Amazonka.OpsWorks.UnassignVolume Methods rnf :: UnassignVolumeResponse -> () # | |
Eq UnassignVolumeResponse Source # | |
Defined in Amazonka.OpsWorks.UnassignVolume Methods (==) :: UnassignVolumeResponse -> UnassignVolumeResponse -> Bool # (/=) :: UnassignVolumeResponse -> UnassignVolumeResponse -> Bool # | |
type Rep UnassignVolumeResponse Source # | |
newUnassignVolumeResponse :: UnassignVolumeResponse Source #
Create a value of UnassignVolumeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UntagResource
data UntagResource Source #
See: newUntagResource
smart constructor.
Constructors
UntagResource' Text [Text] |
Instances
Arguments
:: Text | |
-> UntagResource |
Create a value of UntagResource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:resourceArn:UntagResource'
, untagResource_resourceArn
- The stack or layer's Amazon Resource Number (ARN).
$sel:tagKeys:UntagResource'
, untagResource_tagKeys
- A list of the keys of tags to be removed from a stack or layer.
data UntagResourceResponse Source #
See: newUntagResourceResponse
smart constructor.
Constructors
UntagResourceResponse' | |
Instances
newUntagResourceResponse :: UntagResourceResponse Source #
Create a value of UntagResourceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateApp
See: newUpdateApp
smart constructor.
Constructors
UpdateApp' (Maybe Source) (Maybe (HashMap AppAttributesKeys Text)) (Maybe [DataSource]) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [EnvironmentVariable]) (Maybe Text) (Maybe SslConfiguration) (Maybe AppType) Text |
Instances
Create a value of UpdateApp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateApp
, updateApp_appSource
- A Source
object that specifies the app repository.
UpdateApp
, updateApp_attributes
- One or more user-defined key/value pairs to be added to the stack
attributes.
UpdateApp
, updateApp_dataSources
- The app's data sources.
UpdateApp
, updateApp_description
- A description of the app.
UpdateApp
, updateApp_domains
- The app's virtual host settings, with multiple domains separated by
commas. For example: 'www.example.com, example.com'
UpdateApp
, updateApp_enableSsl
- Whether SSL is enabled for the app.
UpdateApp
, updateApp_environment
- An array of EnvironmentVariable
objects that specify environment
variables to be associated with the app. After you deploy the app, these
variables are defined on the associated app server instances.For more
information, see
Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 20 KB)."
If you have specified one or more environment variables, you cannot modify the stack's Chef version.
UpdateApp
, updateApp_name
- The app name.
UpdateApp
, updateApp_sslConfiguration
- An SslConfiguration
object with the SSL configuration.
UpdateApp
, updateApp_type
- The app type.
UpdateApp
, updateApp_appId
- The app ID.
data UpdateAppResponse Source #
See: newUpdateAppResponse
smart constructor.
Constructors
UpdateAppResponse' | |
Instances
Generic UpdateAppResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateApp Associated Types type Rep UpdateAppResponse :: Type -> Type # Methods from :: UpdateAppResponse -> Rep UpdateAppResponse x # to :: Rep UpdateAppResponse x -> UpdateAppResponse # | |
Read UpdateAppResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateApp Methods readsPrec :: Int -> ReadS UpdateAppResponse # readList :: ReadS [UpdateAppResponse] # | |
Show UpdateAppResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateApp Methods showsPrec :: Int -> UpdateAppResponse -> ShowS # show :: UpdateAppResponse -> String # showList :: [UpdateAppResponse] -> ShowS # | |
NFData UpdateAppResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateApp Methods rnf :: UpdateAppResponse -> () # | |
Eq UpdateAppResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateApp Methods (==) :: UpdateAppResponse -> UpdateAppResponse -> Bool # (/=) :: UpdateAppResponse -> UpdateAppResponse -> Bool # | |
type Rep UpdateAppResponse Source # | |
newUpdateAppResponse :: UpdateAppResponse Source #
Create a value of UpdateAppResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateElasticIp
data UpdateElasticIp Source #
See: newUpdateElasticIp
smart constructor.
Constructors
UpdateElasticIp' (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> UpdateElasticIp |
Create a value of UpdateElasticIp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateElasticIp
, updateElasticIp_name
- The new name.
UpdateElasticIp
, updateElasticIp_elasticIp
- The IP address for which you want to update the name.
data UpdateElasticIpResponse Source #
See: newUpdateElasticIpResponse
smart constructor.
Constructors
UpdateElasticIpResponse' | |
Instances
newUpdateElasticIpResponse :: UpdateElasticIpResponse Source #
Create a value of UpdateElasticIpResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateInstance
data UpdateInstance Source #
See: newUpdateInstance
smart constructor.
Constructors
UpdateInstance' (Maybe Text) (Maybe Text) (Maybe Architecture) (Maybe AutoScalingType) (Maybe Bool) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) Text |
Instances
Arguments
:: Text | |
-> UpdateInstance |
Create a value of UpdateInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateInstance
, updateInstance_agentVersion
- The default AWS OpsWorks Stacks agent version. You have the following
options:
INHERIT
- Use the stack's default agent version setting.- version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.
The default setting is INHERIT
. To specify an agent version, you must
use the complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions.
AgentVersion cannot be set to Chef 12.2.
UpdateInstance
, updateInstance_amiId
- The ID of the AMI that was used to create the instance. The value of
this parameter must be the same AMI ID that the instance is already
using. You cannot apply a new AMI to an instance by running
UpdateInstance. UpdateInstance does not work on instances that are using
custom AMIs.
UpdateInstance
, updateInstance_architecture
- The instance architecture. Instance types do not necessarily support
both architectures. For a list of the architectures that are supported
by the different instance types, see
Instance Families and Types.
UpdateInstance
, updateInstance_autoScalingType
- For load-based or time-based instances, the type. Windows stacks can use
only time-based instances.
UpdateInstance
, updateInstance_ebsOptimized
- This property cannot be updated.
UpdateInstance
, updateInstance_hostname
- The instance host name.
UpdateInstance
, updateInstance_installUpdatesOnBoot
- Whether to install operating system and package updates when the
instance boots. The default value is true
. To control when updates are
installed, set this value to false
. You must then update your
instances manually by using CreateDeployment to run the
update_dependencies
stack command or by manually running yum
(Amazon
Linux) or apt-get
(Ubuntu) on the instances.
We strongly recommend using the default value of true
, to ensure that
your instances have the latest security updates.
UpdateInstance
, updateInstance_instanceType
- The instance type, such as t2.micro
. For a list of supported instance
types, open the stack in the console, choose Instances, and choose
+ Instance. The Size list contains the currently supported
types. For more information, see
Instance Families and Types.
The parameter values that you use to specify the various types are in
the API Name column of the Available Instance Types table.
UpdateInstance
, updateInstance_layerIds
- The instance's layer IDs.
UpdateInstance
, updateInstance_os
- The instance's operating system, which must be set to one of the
following. You cannot update an instance that is using a custom AMI.
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. - A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. CentOS Linux 7
Red Hat Enterprise Linux 7
- A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
.
For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
The default option is the current Amazon Linux version. If you set this
parameter to Custom
, you must use the AmiId parameter to specify the
custom AMI that you want to use. For more information about supported
operating systems, see
Operating Systems.
For more information about how to use custom AMIs with OpsWorks, see
Using Custom AMIs.
You can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.
UpdateInstance
, updateInstance_sshKeyName
- The instance's Amazon EC2 key name.
UpdateInstance
, updateInstance_instanceId
- The instance ID.
data UpdateInstanceResponse Source #
See: newUpdateInstanceResponse
smart constructor.
Constructors
UpdateInstanceResponse' | |
Instances
Generic UpdateInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateInstance Associated Types type Rep UpdateInstanceResponse :: Type -> Type # Methods from :: UpdateInstanceResponse -> Rep UpdateInstanceResponse x # to :: Rep UpdateInstanceResponse x -> UpdateInstanceResponse # | |
Read UpdateInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateInstance | |
Show UpdateInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateInstance Methods showsPrec :: Int -> UpdateInstanceResponse -> ShowS # show :: UpdateInstanceResponse -> String # showList :: [UpdateInstanceResponse] -> ShowS # | |
NFData UpdateInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateInstance Methods rnf :: UpdateInstanceResponse -> () # | |
Eq UpdateInstanceResponse Source # | |
Defined in Amazonka.OpsWorks.UpdateInstance Methods (==) :: UpdateInstanceResponse -> UpdateInstanceResponse -> Bool # (/=) :: UpdateInstanceResponse -> UpdateInstanceResponse -> Bool # | |
type Rep UpdateInstanceResponse Source # | |
newUpdateInstanceResponse :: UpdateInstanceResponse Source #
Create a value of UpdateInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateLayer
data UpdateLayer Source #
See: newUpdateLayer
smart constructor.
Constructors
UpdateLayer' (Maybe (HashMap LayerAttributesKeys (Maybe Text))) (Maybe Bool) (Maybe Bool) (Maybe CloudWatchLogsConfiguration) (Maybe Text) (Maybe Text) (Maybe Recipes) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe LifecycleEventConfiguration) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Bool) (Maybe [VolumeConfiguration]) Text |
Instances
Arguments
:: Text | |
-> UpdateLayer |
Create a value of UpdateLayer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateLayer
, updateLayer_attributes
- One or more user-defined key/value pairs to be added to the stack
attributes.
UpdateLayer
, updateLayer_autoAssignElasticIps
- Whether to automatically assign an
Elastic IP address
to the layer's instances. For more information, see
How to Edit a Layer.
UpdateLayer
, updateLayer_autoAssignPublicIps
- For stacks that are running in a VPC, whether to automatically assign a
public IP address to the layer's instances. For more information, see
How to Edit a Layer.
UpdateLayer
, updateLayer_cloudWatchLogsConfiguration
- Specifies CloudWatch Logs configuration options for the layer. For more
information, see CloudWatchLogsLogStream.
UpdateLayer
, updateLayer_customInstanceProfileArn
- The ARN of an IAM profile to be used for all of the layer's EC2
instances. For more information about IAM ARNs, see
Using Identifiers.
UpdateLayer
, updateLayer_customJson
- A JSON-formatted string containing custom stack configuration and
deployment attributes to be installed on the layer's instances. For
more information, see
Using Custom JSON.
UpdateLayer
, updateLayer_customRecipes
- A LayerCustomRecipes
object that specifies the layer's custom
recipes.
UpdateLayer
, updateLayer_customSecurityGroupIds
- An array containing the layer's custom security group IDs.
UpdateLayer
, updateLayer_enableAutoHealing
- Whether to disable auto healing for the layer.
UpdateLayer
, updateLayer_installUpdatesOnBoot
- Whether to install operating system and package updates when the
instance boots. The default value is true
. To control when updates are
installed, set this value to false
. You must then update your
instances manually by using CreateDeployment to run the
update_dependencies
stack command or manually running yum
(Amazon
Linux) or apt-get
(Ubuntu) on the instances.
We strongly recommend using the default value of true
, to ensure that
your instances have the latest security updates.
UpdateLayer
, updateLayer_lifecycleEventConfiguration
-
UpdateLayer
, updateLayer_name
- The layer name, which is used by the console.
UpdateLayer
, updateLayer_packages
- An array of Package
objects that describe the layer's packages.
UpdateLayer
, updateLayer_shortname
- For custom layers only, use this parameter to specify the layer's short
name, which is used internally by AWS OpsWorks Stacks and by Chef. The
short name is also used as the name for the directory where your app
files are installed. It can have a maximum of 200 characters and must be
in the following format: /\A[a-z0-9\-\_\.]+\Z/.
The built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference
UpdateLayer
, updateLayer_useEbsOptimizedInstances
- Whether to use Amazon EBS-optimized instances.
UpdateLayer
, updateLayer_volumeConfigurations
- A VolumeConfigurations
object that describes the layer's Amazon EBS
volumes.
UpdateLayer
, updateLayer_layerId
- The layer ID.
data UpdateLayerResponse Source #
See: newUpdateLayerResponse
smart constructor.
Constructors
UpdateLayerResponse' | |
Instances
newUpdateLayerResponse :: UpdateLayerResponse Source #
Create a value of UpdateLayerResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateMyUserProfile
data UpdateMyUserProfile Source #
See: newUpdateMyUserProfile
smart constructor.
Constructors
UpdateMyUserProfile' (Maybe Text) |
Instances
newUpdateMyUserProfile :: UpdateMyUserProfile Source #
Create a value of UpdateMyUserProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateMyUserProfile
, updateMyUserProfile_sshPublicKey
- The user's SSH public key.
data UpdateMyUserProfileResponse Source #
See: newUpdateMyUserProfileResponse
smart constructor.
Constructors
UpdateMyUserProfileResponse' | |
Instances
newUpdateMyUserProfileResponse :: UpdateMyUserProfileResponse Source #
Create a value of UpdateMyUserProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateRdsDbInstance
data UpdateRdsDbInstance Source #
See: newUpdateRdsDbInstance
smart constructor.
Instances
newUpdateRdsDbInstance Source #
Arguments
:: Text | |
-> UpdateRdsDbInstance |
Create a value of UpdateRdsDbInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateRdsDbInstance
, updateRdsDbInstance_dbPassword
- The database password.
UpdateRdsDbInstance
, updateRdsDbInstance_dbUser
- The master user name.
UpdateRdsDbInstance
, updateRdsDbInstance_rdsDbInstanceArn
- The Amazon RDS instance's ARN.
data UpdateRdsDbInstanceResponse Source #
See: newUpdateRdsDbInstanceResponse
smart constructor.
Constructors
UpdateRdsDbInstanceResponse' | |
Instances
newUpdateRdsDbInstanceResponse :: UpdateRdsDbInstanceResponse Source #
Create a value of UpdateRdsDbInstanceResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateStack
data UpdateStack Source #
See: newUpdateStack
smart constructor.
Constructors
UpdateStack' (Maybe Text) (Maybe (HashMap StackAttributesKeys (Maybe Text))) (Maybe ChefConfiguration) (Maybe StackConfigurationManager) (Maybe Source) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) Text |
Instances
Arguments
:: Text | |
-> UpdateStack |
Create a value of UpdateStack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateStack
, updateStack_agentVersion
- The default AWS OpsWorks Stacks agent version. You have the following
options:
- Auto-update - Set this parameter to
LATEST
. AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available. - Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the stack's instances.
The default setting is LATEST
. To specify an agent version, you must
use the complete version number, not the abbreviated number shown on the
console. For a list of available agent version numbers, call
DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
UpdateStack
, updateStack_attributes
- One or more user-defined key-value pairs to be added to the stack
attributes.
UpdateStack
, updateStack_chefConfiguration
- A ChefConfiguration
object that specifies whether to enable Berkshelf
and the Berkshelf version on Chef 11.10 stacks. For more information,
see
Create a New Stack.
UpdateStack
, updateStack_configurationManager
- The configuration manager. When you update a stack, we recommend that
you use the configuration manager to specify the Chef version: 12,
11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default
value for Linux stacks is currently 12.
UpdateStack
, updateStack_customCookbooksSource
- Contains the information required to retrieve an app or cookbook from a
repository. For more information, see
Adding Apps
or
Cookbooks and Recipes.
UpdateStack
, updateStack_customJson
- A string that contains user-defined, custom JSON. It can be used to
override the corresponding default stack configuration JSON values or to
pass data to recipes. The string should be in the following format:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.
UpdateStack
, updateStack_defaultAvailabilityZone
- The stack's default Availability Zone, which must be in the stack's
region. For more information, see
Regions and Endpoints.
If you also specify a value for DefaultSubnetId
, the subnet must be in
the same zone. For more information, see CreateStack.
UpdateStack
, updateStack_defaultInstanceProfileArn
- The ARN of an IAM profile that is the default profile for all of the
stack's EC2 instances. For more information about IAM ARNs, see
Using Identifiers.
UpdateStack
, updateStack_defaultOs
- The stack's operating system, which must be set to one of the
following:
- A supported Linux operating system: An Amazon Linux version, such as
Amazon Linux 2018.03
,Amazon Linux 2017.09
,Amazon Linux 2017.03
,Amazon Linux 2016.09
,Amazon Linux 2016.03
,Amazon Linux 2015.09
, orAmazon Linux 2015.03
. - A supported Ubuntu operating system, such as
Ubuntu 16.04 LTS
,Ubuntu 14.04 LTS
, orUbuntu 12.04 LTS
. CentOS Linux 7
Red Hat Enterprise Linux 7
- A supported Windows operating system, such as
Microsoft Windows Server 2012 R2 Base
,Microsoft Windows Server 2012 R2 with SQL Server Express
,Microsoft Windows Server 2012 R2 with SQL Server Standard
, orMicrosoft Windows Server 2012 R2 with SQL Server Web
. - A custom AMI:
Custom
. You specify the custom AMI you want to use when you create instances. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.
The default option is the stack's current operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.
UpdateStack
, updateStack_defaultRootDeviceType
- The default root device type. This value is used by default for all
instances in the stack, but you can override it when you create an
instance. For more information, see
Storage for the Root Device.
UpdateStack
, updateStack_defaultSshKeyName
- A default Amazon EC2 key-pair name. The default value is none
. If you
specify a key-pair name, AWS OpsWorks Stacks installs the public key on
the instance and you can use the private key with an SSH client to log
in to the instance. For more information, see
Using SSH to Communicate with an Instance
and
Managing SSH Access.
You can override this setting by specifying a different key pair, or no
key pair, when you
create an instance.
UpdateStack
, updateStack_defaultSubnetId
- The stack's default VPC subnet ID. This parameter is required if you
specify a value for the VpcId
parameter. All instances are launched
into this subnet unless you specify otherwise when you create the
instance. If you also specify a value for DefaultAvailabilityZone
, the
subnet must be in that zone. For information on default values and when
this parameter is required, see the VpcId
parameter description.
UpdateStack
, updateStack_hostnameTheme
- The stack's new host name theme, with spaces replaced by underscores.
The theme is used to generate host names for the stack's instances. By
default, HostnameTheme
is set to Layer_Dependent
, which creates host
names by appending integers to the layer's short name. The other themes
are:
Baked_Goods
Clouds
Europe_Cities
Fruits
Greek_Deities_and_Titans
Legendary_creatures_from_Japan
Planets_and_Moons
Roman_Deities
Scottish_Islands
US_Cities
Wild_Cats
To obtain a generated host name, call GetHostNameSuggestion
, which
returns a host name based on the current theme.
UpdateStack
, updateStack_name
- The stack's new name.
UpdateStack
, updateStack_serviceRoleArn
- Do not use this parameter. You cannot update a stack's service role.
UpdateStack
, updateStack_useCustomCookbooks
- Whether the stack uses custom cookbooks.
UpdateStack
, updateStack_useOpsworksSecurityGroups
- Whether to associate the AWS OpsWorks Stacks built-in security groups
with the stack's layers.
AWS OpsWorks Stacks provides a standard set of built-in security groups,
one for each layer, which are associated with layers by default.
UseOpsworksSecurityGroups
allows you to provide your own custom
security groups instead of using the built-in groups.
UseOpsworksSecurityGroups
has the following settings:
- True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
- False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on. Custom security groups are required only for those layers that need custom settings.
For more information, see Create a New Stack.
UpdateStack
, updateStack_stackId
- The stack ID.
data UpdateStackResponse Source #
See: newUpdateStackResponse
smart constructor.
Constructors
UpdateStackResponse' | |
Instances
newUpdateStackResponse :: UpdateStackResponse Source #
Create a value of UpdateStackResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateUserProfile
data UpdateUserProfile Source #
See: newUpdateUserProfile
smart constructor.
Instances
Arguments
:: Text | |
-> UpdateUserProfile |
Create a value of UpdateUserProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateUserProfile
, updateUserProfile_allowSelfManagement
- Whether users can specify their own SSH public key through the My
Settings page. For more information, see
Managing User Permissions.
UpdateUserProfile
, updateUserProfile_sshPublicKey
- The user's new SSH public key.
UpdateUserProfile
, updateUserProfile_sshUsername
- The user's SSH user name. The allowable characters are [a-z], [A-Z],
[0-9], '-', and '_'. If the specified name includes other
punctuation marks, AWS OpsWorks Stacks removes them. For example,
my.name
will be changed to myname
. If you do not specify an SSH user
name, AWS OpsWorks Stacks generates one from the IAM user name.
UpdateUserProfile
, updateUserProfile_iamUserArn
- The user IAM ARN. This can also be a federated user's ARN.
data UpdateUserProfileResponse Source #
See: newUpdateUserProfileResponse
smart constructor.
Constructors
UpdateUserProfileResponse' | |
Instances
newUpdateUserProfileResponse :: UpdateUserProfileResponse Source #
Create a value of UpdateUserProfileResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
UpdateVolume
data UpdateVolume Source #
See: newUpdateVolume
smart constructor.
Instances
Arguments
:: Text | |
-> UpdateVolume |
Create a value of UpdateVolume
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
UpdateVolume
, updateVolume_mountPoint
- The new mount point.
UpdateVolume
, updateVolume_name
- The new name.
UpdateVolume
, updateVolume_volumeId
- The volume ID.
data UpdateVolumeResponse Source #
See: newUpdateVolumeResponse
smart constructor.
Constructors
UpdateVolumeResponse' | |
Instances
newUpdateVolumeResponse :: UpdateVolumeResponse Source #
Create a value of UpdateVolumeResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
Types
AppAttributesKeys
newtype AppAttributesKeys Source #
Constructors
AppAttributesKeys' | |
Fields |
Bundled Patterns
pattern AppAttributesKeys_AutoBundleOnDeploy :: AppAttributesKeys | |
pattern AppAttributesKeys_AwsFlowRubySettings :: AppAttributesKeys | |
pattern AppAttributesKeys_DocumentRoot :: AppAttributesKeys | |
pattern AppAttributesKeys_RailsEnv :: AppAttributesKeys |
Instances
AppType
Constructors
AppType' | |
Fields
|
Bundled Patterns
pattern AppType_Aws_flow_ruby :: AppType | |
pattern AppType_Java :: AppType | |
pattern AppType_Nodejs :: AppType | |
pattern AppType_Other :: AppType | |
pattern AppType_Php :: AppType | |
pattern AppType_Rails :: AppType | |
pattern AppType_Static :: AppType |
Instances
Architecture
newtype Architecture Source #
Constructors
Architecture' | |
Fields |
Bundled Patterns
pattern Architecture_I386 :: Architecture | |
pattern Architecture_X86_64 :: Architecture |
Instances
AutoScalingType
newtype AutoScalingType Source #
Constructors
AutoScalingType' | |
Fields |
Bundled Patterns
pattern AutoScalingType_Load :: AutoScalingType | |
pattern AutoScalingType_Timer :: AutoScalingType |
Instances
CloudWatchLogsEncoding
newtype 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
CloudWatchLogsEncoding' | |
Fields |
Bundled Patterns
Instances
CloudWatchLogsInitialPosition
newtype 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
CloudWatchLogsInitialPosition' | |
Fields |
Bundled Patterns
pattern CloudWatchLogsInitialPosition_End_of_file :: CloudWatchLogsInitialPosition | |
pattern CloudWatchLogsInitialPosition_Start_of_file :: CloudWatchLogsInitialPosition |
Instances
CloudWatchLogsTimeZone
newtype CloudWatchLogsTimeZone Source #
The preferred time zone for logs streamed to CloudWatch Logs. Valid
values are LOCAL
and UTC
, for Coordinated Universal Time.
Constructors
CloudWatchLogsTimeZone' | |
Fields |
Bundled Patterns
pattern CloudWatchLogsTimeZone_LOCAL :: CloudWatchLogsTimeZone | |
pattern CloudWatchLogsTimeZone_UTC :: CloudWatchLogsTimeZone |
Instances
DeploymentCommandName
newtype DeploymentCommandName Source #
Constructors
DeploymentCommandName' | |
Fields |
Bundled Patterns
Instances
LayerAttributesKeys
newtype LayerAttributesKeys Source #
Constructors
LayerAttributesKeys' | |
Fields |
Bundled Patterns
Instances
LayerType
Constructors
LayerType' | |
Fields |
Bundled Patterns
pattern LayerType_Aws_flow_ruby :: LayerType | |
pattern LayerType_Custom :: LayerType | |
pattern LayerType_Db_master :: LayerType | |
pattern LayerType_Ecs_cluster :: LayerType | |
pattern LayerType_Java_app :: LayerType | |
pattern LayerType_Lb :: LayerType | |
pattern LayerType_Memcached :: LayerType | |
pattern LayerType_Monitoring_master :: LayerType | |
pattern LayerType_Nodejs_app :: LayerType | |
pattern LayerType_Php_app :: LayerType | |
pattern LayerType_Rails_app :: LayerType | |
pattern LayerType_Web :: LayerType |
Instances
RootDeviceType
newtype RootDeviceType Source #
Constructors
RootDeviceType' | |
Fields |
Bundled Patterns
pattern RootDeviceType_Ebs :: RootDeviceType | |
pattern RootDeviceType_Instance_store :: RootDeviceType |
Instances
SourceType
newtype SourceType Source #
Constructors
SourceType' | |
Fields |
Bundled Patterns
pattern SourceType_Archive :: SourceType | |
pattern SourceType_Git :: SourceType | |
pattern SourceType_S3 :: SourceType | |
pattern SourceType_Svn :: SourceType |
Instances
StackAttributesKeys
newtype StackAttributesKeys Source #
Constructors
StackAttributesKeys' | |
Fields |
Bundled Patterns
pattern StackAttributesKeys_Color :: StackAttributesKeys |
Instances
VirtualizationType
newtype VirtualizationType Source #
Constructors
VirtualizationType' | |
Fields |
Bundled Patterns
pattern VirtualizationType_Hvm :: VirtualizationType | |
pattern VirtualizationType_Paravirtual :: VirtualizationType |
Instances
VolumeType
newtype VolumeType Source #
Constructors
VolumeType' | |
Fields |
Bundled Patterns
pattern VolumeType_Gp2 :: VolumeType | |
pattern VolumeType_Io1 :: VolumeType | |
pattern VolumeType_Standard :: VolumeType |
Instances
AgentVersion
data AgentVersion Source #
Describes an agent version.
See: newAgentVersion
smart constructor.
Constructors
AgentVersion' (Maybe StackConfigurationManager) (Maybe Text) |
Instances
newAgentVersion :: AgentVersion Source #
Create a value of AgentVersion
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationManager:AgentVersion'
, agentVersion_configurationManager
- The configuration manager.
AgentVersion
, agentVersion_version
- The agent version.
App
A description of the app.
See: newApp
smart constructor.
Constructors
App' (Maybe Text) (Maybe Source) (Maybe (HashMap AppAttributesKeys Text)) (Maybe Text) (Maybe [DataSource]) (Maybe Text) (Maybe [Text]) (Maybe Bool) (Maybe [EnvironmentVariable]) (Maybe Text) (Maybe Text) (Maybe SslConfiguration) (Maybe Text) (Maybe AppType) |
Instances
Create a value of App
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appId:App'
, app_appId
- The app ID.
$sel:appSource:App'
, app_appSource
- A Source
object that describes the app repository.
$sel:attributes:App'
, app_attributes
- The stack attributes.
$sel:createdAt:App'
, app_createdAt
- When the app was created.
$sel:dataSources:App'
, app_dataSources
- The app's data sources.
$sel:description:App'
, app_description
- A description of the app.
$sel:domains:App'
, app_domains
- The app vhost settings with multiple domains separated by commas. For
example: 'www.example.com, example.com'
$sel:enableSsl:App'
, app_enableSsl
- Whether to enable SSL for the app.
$sel:environment:App'
, app_environment
- An array of EnvironmentVariable
objects that specify environment
variables to be associated with the app. After you deploy the app, these
variables are defined on the associated app server instances. For more
information, see
Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variable names, values, and protected flag values - cannot exceed 20 KB. This limit should accommodate most if not all use cases, but if you do exceed it, you will cause an exception (API) with an "Environment: is too large (maximum is 20 KB)" message.
$sel:name:App'
, app_name
- The app name.
$sel:shortname:App'
, app_shortname
- The app's short name.
$sel:sslConfiguration:App'
, app_sslConfiguration
- An SslConfiguration
object with the SSL configuration.
$sel:stackId:App'
, app_stackId
- The app stack ID.
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: newAutoScalingThresholds
smart constructor.
Constructors
AutoScalingThresholds' (Maybe [Text]) (Maybe Double) (Maybe Natural) (Maybe Int) (Maybe Double) (Maybe Double) (Maybe Natural) |
Instances
newAutoScalingThresholds :: AutoScalingThresholds Source #
Create a value of AutoScalingThresholds
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:alarms:AutoScalingThresholds'
, autoScalingThresholds_alarms
- Custom Cloudwatch auto scaling alarms, to be used as thresholds. This
parameter takes a list of up to five alarm names, which are case
sensitive and must be in the same region as the stack.
To use custom alarms, you must update your service role to allow
cloudwatch:DescribeAlarms
. You can either have AWS OpsWorks Stacks
update the role for you when you first use this feature or you can edit
the role manually. For more information, see
Allowing AWS OpsWorks Stacks to Act on Your Behalf.
$sel:cpuThreshold:AutoScalingThresholds'
, autoScalingThresholds_cpuThreshold
- The CPU utilization threshold, as a percent of the available CPU. A
value of -1 disables the threshold.
$sel:ignoreMetricsTime:AutoScalingThresholds'
, autoScalingThresholds_ignoreMetricsTime
- 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.
$sel:instanceCount:AutoScalingThresholds'
, autoScalingThresholds_instanceCount
- The number of instances to add or remove when the load exceeds a
threshold.
$sel:loadThreshold:AutoScalingThresholds'
, autoScalingThresholds_loadThreshold
- The load threshold. A value of -1 disables the threshold. For more
information about how load is computed, see
Load (computing).
$sel:memoryThreshold:AutoScalingThresholds'
, autoScalingThresholds_memoryThreshold
- The memory utilization threshold, as a percent of the available memory.
A value of -1 disables the threshold.
$sel:thresholdsWaitTime:AutoScalingThresholds'
, autoScalingThresholds_thresholdsWaitTime
- The amount of time, in minutes, that the load must exceed a threshold
before more instances are added or removed.
BlockDeviceMapping
data BlockDeviceMapping Source #
Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.
See: newBlockDeviceMapping
smart constructor.
Constructors
BlockDeviceMapping' (Maybe Text) (Maybe EbsBlockDevice) (Maybe Text) (Maybe Text) |
Instances
newBlockDeviceMapping :: BlockDeviceMapping Source #
Create a value of BlockDeviceMapping
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deviceName:BlockDeviceMapping'
, blockDeviceMapping_deviceName
- The device name that is exposed to the instance, such as /dev/sdh
.
For the root device, you can use the explicit device name or you can set
this parameter to ROOT_DEVICE
and AWS OpsWorks Stacks will provide the
correct device name.
$sel:ebs:BlockDeviceMapping'
, blockDeviceMapping_ebs
- An EBSBlockDevice
that defines how to configure an Amazon EBS volume
when the instance is launched.
$sel:noDevice:BlockDeviceMapping'
, blockDeviceMapping_noDevice
- Suppresses the specified device included in the AMI's block device
mapping.
$sel:virtualName:BlockDeviceMapping'
, blockDeviceMapping_virtualName
- The virtual device name. For more information, see
BlockDeviceMapping.
ChefConfiguration
data ChefConfiguration Source #
Describes the Chef configuration.
See: newChefConfiguration
smart constructor.
Constructors
ChefConfiguration' (Maybe Text) (Maybe Bool) |
Instances
newChefConfiguration :: ChefConfiguration Source #
Create a value of ChefConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:berkshelfVersion:ChefConfiguration'
, chefConfiguration_berkshelfVersion
- The Berkshelf version.
$sel:manageBerkshelf:ChefConfiguration'
, chefConfiguration_manageBerkshelf
- Whether to enable Berkshelf.
CloudWatchLogsConfiguration
data CloudWatchLogsConfiguration Source #
Describes the Amazon CloudWatch logs configuration for a layer.
See: newCloudWatchLogsConfiguration
smart constructor.
Constructors
CloudWatchLogsConfiguration' (Maybe Bool) (Maybe [CloudWatchLogsLogStream]) |
Instances
newCloudWatchLogsConfiguration :: CloudWatchLogsConfiguration Source #
Create a value of CloudWatchLogsConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:enabled:CloudWatchLogsConfiguration'
, cloudWatchLogsConfiguration_enabled
- Whether CloudWatch Logs is enabled for a layer.
$sel:logStreams:CloudWatchLogsConfiguration'
, cloudWatchLogsConfiguration_logStreams
- 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: newCloudWatchLogsLogStream
smart constructor.
Constructors
Instances
newCloudWatchLogsLogStream :: CloudWatchLogsLogStream Source #
Create a value of CloudWatchLogsLogStream
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:batchCount:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_batchCount
- Specifies the max number of log events in a batch, up to 10000. The
default value is 1000.
$sel:batchSize:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_batchSize
- 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.
$sel:bufferDuration:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_bufferDuration
- Specifies the time duration for the batching of log events. The minimum
value is 5000ms and default value is 5000ms.
$sel:datetimeFormat:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_datetimeFormat
- Specifies how the time stamp is extracted from logs. For more
information, see the
CloudWatch Logs Agent Reference.
$sel:encoding:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_encoding
- 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.
$sel:file:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_file
- Specifies log files that you want to push to CloudWatch Logs.
File
can point to a specific file or multiple files (by using wild
card characters such as /var/log/system.log*
). Only the latest file
is pushed to CloudWatch Logs, based on file modification time. We
recommend that you use wild card characters to specify a series of files
of the same type, such as access_log.2014-06-01-01
,
access_log.2014-06-01-02
, and so on by using a pattern like
access_log.*
. Don't use a wildcard to match multiple file types, such
as access_log_80
and access_log_443
. To specify multiple, different
file types, add another log stream entry to the configuration file, so
that each log file type is stored in a different log group.
Zipped files are not supported.
$sel:fileFingerprintLines:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_fileFingerprintLines
- 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.
$sel:initialPosition:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_initialPosition
- 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.
$sel:logGroupName:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_logGroupName
- 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).
$sel:multiLineStartPattern:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_multiLineStartPattern
- Specifies the pattern for identifying the start of a log message.
$sel:timeZone:CloudWatchLogsLogStream'
, cloudWatchLogsLogStream_timeZone
- Specifies the time zone of log event time stamps.
Command
Describes a command.
See: newCommand
smart constructor.
Constructors
Command' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newCommand :: Command Source #
Create a value of Command
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:acknowledgedAt:Command'
, command_acknowledgedAt
- Date and time when the command was acknowledged.
$sel:commandId:Command'
, command_commandId
- The command ID.
$sel:completedAt:Command'
, command_completedAt
- Date when the command completed.
$sel:createdAt:Command'
, command_createdAt
- Date and time when the command was run.
$sel:deploymentId:Command'
, command_deploymentId
- The command deployment ID.
$sel:exitCode:Command'
, command_exitCode
- The command exit code.
$sel:instanceId:Command'
, command_instanceId
- The ID of the instance where the command was executed.
$sel:logUrl:Command'
, command_logUrl
- The URL of the command log.
$sel:status:Command'
, command_status
- The command status:
- failed
- successful
- skipped
- pending
$sel:type':Command'
, command_type
- The command type:
configure
deploy
execute_recipes
install_dependencies
restart
rollback
setup
start
stop
undeploy
update_custom_cookbooks
update_dependencies
DataSource
data DataSource Source #
Describes an app's data source.
See: newDataSource
smart constructor.
Instances
newDataSource :: DataSource Source #
Create a value of DataSource
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:DataSource'
, dataSource_arn
- The data source's ARN.
$sel:databaseName:DataSource'
, dataSource_databaseName
- The database name.
$sel:type':DataSource'
, dataSource_type
- The data source's type, AutoSelectOpsworksMysqlInstance
,
OpsworksMysqlInstance
, RdsDbInstance
, or None
.
Deployment
data Deployment Source #
Describes a deployment of a stack or app.
See: newDeployment
smart constructor.
Constructors
Deployment' (Maybe Text) (Maybe DeploymentCommand) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) |
Instances
newDeployment :: Deployment Source #
Create a value of Deployment
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appId:Deployment'
, deployment_appId
- The app ID.
$sel:command:Deployment'
, deployment_command
- Used to specify a stack or deployment command.
$sel:comment:Deployment'
, deployment_comment
- A user-defined comment.
$sel:completedAt:Deployment'
, deployment_completedAt
- Date when the deployment completed.
$sel:createdAt:Deployment'
, deployment_createdAt
- Date when the deployment was created.
$sel:customJson:Deployment'
, deployment_customJson
- 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.
$sel:deploymentId:Deployment'
, deployment_deploymentId
- The deployment ID.
$sel:duration:Deployment'
, deployment_duration
- The deployment duration.
$sel:iamUserArn:Deployment'
, deployment_iamUserArn
- The user's IAM ARN.
$sel:instanceIds:Deployment'
, deployment_instanceIds
- The IDs of the target instances.
$sel:stackId:Deployment'
, deployment_stackId
- The stack ID.
$sel:status:Deployment'
, deployment_status
- The deployment status:
- running
- successful
- failed
DeploymentCommand
data DeploymentCommand Source #
Used to specify a stack or deployment command.
See: newDeploymentCommand
smart constructor.
Constructors
DeploymentCommand' (Maybe (HashMap Text [Text])) DeploymentCommandName |
Instances
Create a value of DeploymentCommand
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:args:DeploymentCommand'
, deploymentCommand_args
- 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 asAmazon Linux 2016.09
. You must also set theallow_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 eithertrue
orfalse
. The default value isfalse
.
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"] }
$sel:name:DeploymentCommand'
, deploymentCommand_name
- 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 executephpapp::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 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: newEbsBlockDevice
smart constructor.
Instances
newEbsBlockDevice :: EbsBlockDevice Source #
Create a value of EbsBlockDevice
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:deleteOnTermination:EbsBlockDevice'
, ebsBlockDevice_deleteOnTermination
- Whether the volume is deleted on instance termination.
$sel:iops:EbsBlockDevice'
, ebsBlockDevice_iops
- The number of I/O operations per second (IOPS) that the volume
supports. For more information, see
EbsBlockDevice.
$sel:snapshotId:EbsBlockDevice'
, ebsBlockDevice_snapshotId
- The snapshot ID.
$sel:volumeSize:EbsBlockDevice'
, ebsBlockDevice_volumeSize
- The volume size, in GiB. For more information, see
EbsBlockDevice.
$sel:volumeType:EbsBlockDevice'
, ebsBlockDevice_volumeType
- The volume type. gp2
for General Purpose (SSD) volumes, io1
for
Provisioned IOPS (SSD) volumes, st1
for Throughput Optimized hard disk
drives (HDD), sc1
for Cold HDD,and standard
for Magnetic volumes.
If you specify the io1
volume type, you must also specify a value for
the Iops
attribute. The maximum ratio of provisioned IOPS to requested
volume size (in GiB) is 50:1. AWS uses the default volume size (in GiB)
specified in the AMI attributes to set IOPS to 50 x (volume size).
EcsCluster
data EcsCluster Source #
Describes a registered Amazon ECS cluster.
See: newEcsCluster
smart constructor.
Instances
newEcsCluster :: EcsCluster Source #
Create a value of EcsCluster
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:ecsClusterArn:EcsCluster'
, ecsCluster_ecsClusterArn
- The cluster's ARN.
$sel:ecsClusterName:EcsCluster'
, ecsCluster_ecsClusterName
- The cluster name.
$sel:registeredAt:EcsCluster'
, ecsCluster_registeredAt
- The time and date that the cluster was registered with the stack.
$sel:stackId:EcsCluster'
, ecsCluster_stackId
- The stack ID.
ElasticIp
Describes an Elastic IP address.
See: newElasticIp
smart constructor.
Instances
newElasticIp :: ElasticIp Source #
Create a value of ElasticIp
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:domain:ElasticIp'
, elasticIp_domain
- The domain.
$sel:instanceId:ElasticIp'
, elasticIp_instanceId
- The ID of the instance that the address is attached to.
$sel:ip:ElasticIp'
, elasticIp_ip
- The IP address.
$sel:name:ElasticIp'
, elasticIp_name
- The name.
$sel:region:ElasticIp'
, elasticIp_region
- The AWS region. For more information, see
Regions and Endpoints.
ElasticLoadBalancer
data ElasticLoadBalancer Source #
Describes an Elastic Load Balancing instance.
See: newElasticLoadBalancer
smart constructor.
Constructors
ElasticLoadBalancer' (Maybe [Text]) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) |
Instances
newElasticLoadBalancer :: ElasticLoadBalancer Source #
Create a value of ElasticLoadBalancer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityZones:ElasticLoadBalancer'
, elasticLoadBalancer_availabilityZones
- A list of Availability Zones.
$sel:dnsName:ElasticLoadBalancer'
, elasticLoadBalancer_dnsName
- The instance's public DNS name.
$sel:ec2InstanceIds:ElasticLoadBalancer'
, elasticLoadBalancer_ec2InstanceIds
- A list of the EC2 instances that the Elastic Load Balancing instance is
managing traffic for.
$sel:elasticLoadBalancerName:ElasticLoadBalancer'
, elasticLoadBalancer_elasticLoadBalancerName
- The Elastic Load Balancing instance's name.
$sel:layerId:ElasticLoadBalancer'
, elasticLoadBalancer_layerId
- The ID of the layer that the instance is attached to.
$sel:region:ElasticLoadBalancer'
, elasticLoadBalancer_region
- The instance's AWS region.
$sel:stackId:ElasticLoadBalancer'
, elasticLoadBalancer_stackId
- The ID of the stack that the instance is associated with.
$sel:subnetIds:ElasticLoadBalancer'
, elasticLoadBalancer_subnetIds
- A list of subnet IDs, if the stack is running in a VPC.
$sel:vpcId:ElasticLoadBalancer'
, elasticLoadBalancer_vpcId
- The VPC ID.
EnvironmentVariable
data EnvironmentVariable Source #
Represents an app's environment variable.
See: newEnvironmentVariable
smart constructor.
Constructors
EnvironmentVariable' (Maybe Bool) Text Text |
Instances
newEnvironmentVariable Source #
Arguments
:: Text | |
-> Text | |
-> EnvironmentVariable |
Create a value of EnvironmentVariable
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:secure:EnvironmentVariable'
, environmentVariable_secure
- (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
.
$sel:key:EnvironmentVariable'
, environmentVariable_key
- (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.
$sel:value:EnvironmentVariable'
, environmentVariable_value
- (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: newInstance
smart constructor.
Constructors
Instance' (Maybe Text) (Maybe Text) (Maybe Architecture) (Maybe Text) (Maybe AutoScalingType) (Maybe Text) (Maybe [BlockDeviceMapping]) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe ReportedOs) (Maybe RootDeviceType) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe VirtualizationType) |
Instances
newInstance :: Instance Source #
Create a value of Instance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentVersion:Instance'
, instance_agentVersion
- 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.
$sel:amiId:Instance'
, instance_amiId
- A custom AMI ID to be used to create the instance. For more information,
see
Instances
$sel:architecture:Instance'
, instance_architecture
- The instance architecture: "i386" or "x86_64".
$sel:arn:Instance'
, instance_arn
- The instance's Amazon Resource Number (ARN).
$sel:autoScalingType:Instance'
, instance_autoScalingType
- For load-based or time-based instances, the type.
$sel:availabilityZone:Instance'
, instance_availabilityZone
- The instance Availability Zone. For more information, see
Regions and Endpoints.
$sel:blockDeviceMappings:Instance'
, instance_blockDeviceMappings
- An array of BlockDeviceMapping
objects that specify the instance's
block device mappings.
$sel:createdAt:Instance'
, instance_createdAt
- The time that the instance was created.
$sel:ebsOptimized:Instance'
, instance_ebsOptimized
- Whether this is an Amazon EBS-optimized instance.
$sel:ec2InstanceId:Instance'
, instance_ec2InstanceId
- The ID of the associated Amazon EC2 instance.
$sel:ecsClusterArn:Instance'
, instance_ecsClusterArn
- For container instances, the Amazon ECS cluster's ARN.
$sel:ecsContainerInstanceArn:Instance'
, instance_ecsContainerInstanceArn
- For container instances, the instance's ARN.
$sel:elasticIp:Instance'
, instance_elasticIp
- The instance
Elastic IP address
.
$sel:hostname:Instance'
, instance_hostname
- The instance host name.
$sel:infrastructureClass:Instance'
, instance_infrastructureClass
- For registered instances, the infrastructure class: ec2
or
on-premises
.
$sel:installUpdatesOnBoot:Instance'
, instance_installUpdatesOnBoot
- 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.
$sel:instanceId:Instance'
, instance_instanceId
- The instance ID.
$sel:instanceProfileArn:Instance'
, instance_instanceProfileArn
- The ARN of the instance's IAM profile. For more information about IAM
ARNs, see
Using Identifiers.
$sel:instanceType:Instance'
, instance_instanceType
- The instance type, such as t2.micro
.
$sel:lastServiceErrorId:Instance'
, instance_lastServiceErrorId
- The ID of the last service error. For more information, call
DescribeServiceErrors.
$sel:layerIds:Instance'
, instance_layerIds
- An array containing the instance layer IDs.
$sel:os:Instance'
, instance_os
- The instance's operating system.
$sel:platform:Instance'
, instance_platform
- The instance's platform.
$sel:privateDns:Instance'
, instance_privateDns
- The instance's private DNS name.
$sel:privateIp:Instance'
, instance_privateIp
- The instance's private IP address.
$sel:publicDns:Instance'
, instance_publicDns
- The instance public DNS name.
$sel:publicIp:Instance'
, instance_publicIp
- The instance public IP address.
$sel:registeredBy:Instance'
, instance_registeredBy
- For registered instances, who performed the registration.
$sel:reportedAgentVersion:Instance'
, instance_reportedAgentVersion
- The instance's reported AWS OpsWorks Stacks agent version.
$sel:reportedOs:Instance'
, instance_reportedOs
- For registered instances, the reported operating system.
$sel:rootDeviceType:Instance'
, instance_rootDeviceType
- The instance's root device type. For more information, see
Storage for the Root Device.
$sel:rootDeviceVolumeId:Instance'
, instance_rootDeviceVolumeId
- The root device volume ID.
$sel:securityGroupIds:Instance'
, instance_securityGroupIds
- An array containing the instance security group IDs.
$sel:sshHostDsaKeyFingerprint:Instance'
, instance_sshHostDsaKeyFingerprint
- The SSH key's Deep Security Agent (DSA) fingerprint.
$sel:sshHostRsaKeyFingerprint:Instance'
, instance_sshHostRsaKeyFingerprint
- The SSH key's RSA fingerprint.
$sel:sshKeyName:Instance'
, instance_sshKeyName
- The instance's Amazon EC2 key-pair name.
$sel:stackId:Instance'
, instance_stackId
- The stack ID.
$sel:status:Instance'
, instance_status
- The instance status:
booting
connection_lost
online
pending
rebooting
requested
running_setup
setup_failed
shutting_down
start_failed
stop_failed
stopped
stopping
terminated
terminating
$sel:subnetId:Instance'
, instance_subnetId
- The instance's subnet ID; applicable only if the stack is running in a
VPC.
$sel:tenancy:Instance'
, instance_tenancy
- The instance's tenancy option, such as dedicated
or host
.
$sel:virtualizationType:Instance'
, instance_virtualizationType
- The instance's virtualization type: paravirtual
or hvm
.
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: newInstanceIdentity
smart constructor.
Constructors
InstanceIdentity' (Maybe Text) (Maybe Text) |
Instances
newInstanceIdentity :: InstanceIdentity Source #
Create a value of InstanceIdentity
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:document:InstanceIdentity'
, instanceIdentity_document
- A JSON document that contains the metadata.
$sel:signature:InstanceIdentity'
, instanceIdentity_signature
- A signature that can be used to verify the document's accuracy and
authenticity.
InstancesCount
data InstancesCount Source #
Describes how many instances a stack has for each status.
See: newInstancesCount
smart constructor.
Constructors
InstancesCount' (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) (Maybe Int) |
Instances
newInstancesCount :: InstancesCount Source #
Create a value of InstancesCount
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:assigning:InstancesCount'
, instancesCount_assigning
- The number of instances in the Assigning state.
$sel:booting:InstancesCount'
, instancesCount_booting
- The number of instances with booting
status.
$sel:connectionLost:InstancesCount'
, instancesCount_connectionLost
- The number of instances with connection_lost
status.
$sel:deregistering:InstancesCount'
, instancesCount_deregistering
- The number of instances in the Deregistering state.
$sel:online:InstancesCount'
, instancesCount_online
- The number of instances with online
status.
$sel:pending:InstancesCount'
, instancesCount_pending
- The number of instances with pending
status.
$sel:rebooting:InstancesCount'
, instancesCount_rebooting
- The number of instances with rebooting
status.
$sel:registered:InstancesCount'
, instancesCount_registered
- The number of instances in the Registered state.
$sel:registering:InstancesCount'
, instancesCount_registering
- The number of instances in the Registering state.
$sel:requested:InstancesCount'
, instancesCount_requested
- The number of instances with requested
status.
$sel:runningSetup:InstancesCount'
, instancesCount_runningSetup
- The number of instances with running_setup
status.
$sel:setupFailed:InstancesCount'
, instancesCount_setupFailed
- The number of instances with setup_failed
status.
$sel:shuttingDown:InstancesCount'
, instancesCount_shuttingDown
- The number of instances with shutting_down
status.
$sel:startFailed:InstancesCount'
, instancesCount_startFailed
- The number of instances with start_failed
status.
$sel:stopFailed:InstancesCount'
, instancesCount_stopFailed
- The number of instances with stop_failed
status.
$sel:stopped:InstancesCount'
, instancesCount_stopped
- The number of instances with stopped
status.
$sel:stopping:InstancesCount'
, instancesCount_stopping
- The number of instances with stopping
status.
$sel:terminated:InstancesCount'
, instancesCount_terminated
- The number of instances with terminated
status.
$sel:terminating:InstancesCount'
, instancesCount_terminating
- The number of instances with terminating
status.
$sel:unassigning:InstancesCount'
, instancesCount_unassigning
- The number of instances in the Unassigning state.
Layer
Describes a layer.
See: newLayer
smart constructor.
Constructors
Layer' (Maybe Text) (Maybe (HashMap LayerAttributesKeys (Maybe Text))) (Maybe Bool) (Maybe Bool) (Maybe CloudWatchLogsConfiguration) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Recipes) (Maybe [Text]) (Maybe Recipes) (Maybe [Text]) (Maybe Bool) (Maybe Bool) (Maybe Text) (Maybe LifecycleEventConfiguration) (Maybe Text) (Maybe [Text]) (Maybe Text) (Maybe Text) (Maybe LayerType) (Maybe Bool) (Maybe [VolumeConfiguration]) |
Instances
Create a value of Layer
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:arn:Layer'
, layer_arn
- The Amazon Resource Number (ARN) of a layer.
$sel:attributes:Layer'
, layer_attributes
- 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.
$sel:autoAssignElasticIps:Layer'
, layer_autoAssignElasticIps
- Whether to automatically assign an
Elastic IP address
to the layer's instances. For more information, see
How to Edit a Layer.
$sel:autoAssignPublicIps:Layer'
, layer_autoAssignPublicIps
- 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.
$sel:cloudWatchLogsConfiguration:Layer'
, layer_cloudWatchLogsConfiguration
- The Amazon CloudWatch Logs configuration settings for the layer.
$sel:createdAt:Layer'
, layer_createdAt
- Date when the layer was created.
$sel:customInstanceProfileArn:Layer'
, layer_customInstanceProfileArn
- 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.
$sel:customJson:Layer'
, layer_customJson
- A JSON formatted string containing the layer's custom stack
configuration and deployment attributes.
$sel:customRecipes:Layer'
, layer_customRecipes
- A LayerCustomRecipes
object that specifies the layer's custom
recipes.
$sel:customSecurityGroupIds:Layer'
, layer_customSecurityGroupIds
- An array containing the layer's custom security group IDs.
$sel:defaultRecipes:Layer'
, layer_defaultRecipes
- AWS OpsWorks Stacks supports five lifecycle events: setup,
configuration, deploy, undeploy, and shutdown. For each
layer, AWS OpsWorks Stacks runs a set of standard recipes for each
event. You can also provide custom recipes for any or all layers and
events. AWS OpsWorks Stacks runs custom event recipes after the standard
recipes. LayerCustomRecipes
specifies the custom recipes for a
particular layer to be run in response to each of the five events.
To specify a recipe, use the cookbook's directory name in the
repository followed by two colons and the recipe name, which is the
recipe's file name without the .rb
extension. For example:
phpapp2::dbsetup
specifies the dbsetup.rb
recipe in the
repository's phpapp2
folder.
$sel:defaultSecurityGroupNames:Layer'
, layer_defaultSecurityGroupNames
- An array containing the layer's security group names.
$sel:enableAutoHealing:Layer'
, layer_enableAutoHealing
- Whether auto healing is disabled for the layer.
$sel:installUpdatesOnBoot:Layer'
, layer_installUpdatesOnBoot
- 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.
$sel:layerId:Layer'
, layer_layerId
- The layer ID.
$sel:lifecycleEventConfiguration:Layer'
, layer_lifecycleEventConfiguration
- A LifeCycleEventConfiguration
object that specifies the Shutdown event
configuration.
$sel:name:Layer'
, layer_name
- The layer name.
$sel:packages:Layer'
, layer_packages
- An array of Package
objects that describe the layer's packages.
$sel:shortname:Layer'
, layer_shortname
- The layer short name.
$sel:stackId:Layer'
, layer_stackId
- The layer stack ID.
$sel:type':Layer'
, layer_type
- The layer type.
$sel:useEbsOptimizedInstances:Layer'
, layer_useEbsOptimizedInstances
- Whether the layer uses Amazon EBS-optimized instances.
$sel:volumeConfigurations:Layer'
, layer_volumeConfigurations
- A VolumeConfigurations
object that describes the layer's Amazon EBS
volumes.
LifecycleEventConfiguration
data LifecycleEventConfiguration Source #
Specifies the lifecycle event configuration
See: newLifecycleEventConfiguration
smart constructor.
Constructors
LifecycleEventConfiguration' (Maybe ShutdownEventConfiguration) |
Instances
newLifecycleEventConfiguration :: LifecycleEventConfiguration Source #
Create a value of LifecycleEventConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:shutdown:LifecycleEventConfiguration'
, lifecycleEventConfiguration_shutdown
- A ShutdownEventConfiguration
object that specifies the Shutdown event
configuration.
LoadBasedAutoScalingConfiguration
data LoadBasedAutoScalingConfiguration Source #
Describes a layer's load-based auto scaling configuration.
See: newLoadBasedAutoScalingConfiguration
smart constructor.
Constructors
LoadBasedAutoScalingConfiguration' (Maybe AutoScalingThresholds) (Maybe Bool) (Maybe Text) (Maybe AutoScalingThresholds) |
Instances
newLoadBasedAutoScalingConfiguration :: LoadBasedAutoScalingConfiguration Source #
Create a value of LoadBasedAutoScalingConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:downScaling:LoadBasedAutoScalingConfiguration'
, loadBasedAutoScalingConfiguration_downScaling
- An AutoScalingThresholds
object that describes the downscaling
configuration, which defines how and when AWS OpsWorks Stacks reduces
the number of instances.
$sel:enable:LoadBasedAutoScalingConfiguration'
, loadBasedAutoScalingConfiguration_enable
- Whether load-based auto scaling is enabled for the layer.
$sel:layerId:LoadBasedAutoScalingConfiguration'
, loadBasedAutoScalingConfiguration_layerId
- The layer ID.
$sel:upScaling:LoadBasedAutoScalingConfiguration'
, loadBasedAutoScalingConfiguration_upScaling
- An AutoScalingThresholds
object that describes the upscaling
configuration, which defines how and when AWS OpsWorks Stacks increases
the number of instances.
OperatingSystem
data OperatingSystem Source #
Describes supported operating systems in AWS OpsWorks Stacks.
See: newOperatingSystem
smart constructor.
Constructors
OperatingSystem' (Maybe [OperatingSystemConfigurationManager]) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) |
Instances
newOperatingSystem :: OperatingSystem Source #
Create a value of OperatingSystem
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configurationManagers:OperatingSystem'
, operatingSystem_configurationManagers
- Supported configuration manager name and versions for an AWS OpsWorks
Stacks operating system.
$sel:id:OperatingSystem'
, operatingSystem_id
- The ID of a supported operating system, such as Amazon Linux 2018.03
.
OperatingSystem
, operatingSystem_name
- The name of the operating system, such as Amazon Linux 2018.03
.
$sel:reportedName:OperatingSystem'
, operatingSystem_reportedName
- A short name for the operating system manufacturer.
$sel:reportedVersion:OperatingSystem'
, operatingSystem_reportedVersion
- The version of the operating system, including the release and edition,
if applicable.
$sel:supported:OperatingSystem'
, operatingSystem_supported
- Indicates that an operating system is not supported for new instances.
$sel:type':OperatingSystem'
, operatingSystem_type
- The type of a supported operating system, either Linux
or Windows
.
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: newOperatingSystemConfigurationManager
smart constructor.
Constructors
OperatingSystemConfigurationManager' (Maybe Text) (Maybe Text) |
Instances
newOperatingSystemConfigurationManager :: OperatingSystemConfigurationManager Source #
Create a value of OperatingSystemConfigurationManager
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:OperatingSystemConfigurationManager'
, operatingSystemConfigurationManager_name
- The name of the configuration manager, which is Chef.
$sel:version:OperatingSystemConfigurationManager'
, operatingSystemConfigurationManager_version
- The versions of the configuration manager that are supported by an
operating system.
Permission
data Permission Source #
Describes stack or user permissions.
See: newPermission
smart constructor.
Instances
newPermission :: Permission Source #
Create a value of Permission
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowSsh:Permission'
, permission_allowSsh
- Whether the user can use SSH.
$sel:allowSudo:Permission'
, permission_allowSudo
- Whether the user can use sudo.
$sel:iamUserArn:Permission'
, permission_iamUserArn
- The Amazon Resource Name (ARN) for an AWS Identity and Access Management
(IAM) role. For more information about IAM ARNs, see
Using Identifiers.
$sel:level:Permission'
, permission_level
- 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
$sel:stackId:Permission'
, permission_stackId
- A stack ID.
RaidArray
Describes an instance's RAID array.
See: newRaidArray
smart constructor.
Constructors
RaidArray' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Int) (Maybe Int) (Maybe Text) (Maybe Text) |
Instances
newRaidArray :: RaidArray Source #
Create a value of RaidArray
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityZone:RaidArray'
, raidArray_availabilityZone
- The array's Availability Zone. For more information, see
Regions and Endpoints.
$sel:createdAt:RaidArray'
, raidArray_createdAt
- When the RAID array was created.
$sel:device:RaidArray'
, raidArray_device
- The array's Linux device. For example /dev/mdadm0.
$sel:instanceId:RaidArray'
, raidArray_instanceId
- The instance ID.
$sel:iops:RaidArray'
, raidArray_iops
- For PIOPS volumes, the IOPS per disk.
$sel:mountPoint:RaidArray'
, raidArray_mountPoint
- The array's mount point.
$sel:name:RaidArray'
, raidArray_name
- The array name.
$sel:numberOfDisks:RaidArray'
, raidArray_numberOfDisks
- The number of disks in the array.
$sel:raidArrayId:RaidArray'
, raidArray_raidArrayId
- The array ID.
$sel:raidLevel:RaidArray'
, raidArray_raidLevel
- The RAID level.
$sel:size:RaidArray'
, raidArray_size
- The array's size.
$sel:stackId:RaidArray'
, raidArray_stackId
- The stack ID.
$sel:volumeType:RaidArray'
, raidArray_volumeType
- The volume type, standard or PIOPS.
RdsDbInstance
data RdsDbInstance Source #
Describes an Amazon RDS instance.
See: newRdsDbInstance
smart constructor.
Constructors
RdsDbInstance' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newRdsDbInstance :: RdsDbInstance Source #
Create a value of RdsDbInstance
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:address:RdsDbInstance'
, rdsDbInstance_address
- The instance's address.
$sel:dbInstanceIdentifier:RdsDbInstance'
, rdsDbInstance_dbInstanceIdentifier
- The DB instance identifier.
$sel:dbPassword:RdsDbInstance'
, rdsDbInstance_dbPassword
- AWS OpsWorks Stacks returns *****FILTERED*****
instead of the actual
value.
$sel:dbUser:RdsDbInstance'
, rdsDbInstance_dbUser
- The master user name.
$sel:engine:RdsDbInstance'
, rdsDbInstance_engine
- The instance's database engine.
$sel:missingOnRds:RdsDbInstance'
, rdsDbInstance_missingOnRds
- 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.
$sel:rdsDbInstanceArn:RdsDbInstance'
, rdsDbInstance_rdsDbInstanceArn
- The instance's ARN.
$sel:region:RdsDbInstance'
, rdsDbInstance_region
- The instance's AWS region.
$sel:stackId:RdsDbInstance'
, rdsDbInstance_stackId
- The ID of the stack with which the instance is registered.
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: newRecipes
smart constructor.
Instances
newRecipes :: Recipes Source #
Create a value of Recipes
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:configure:Recipes'
, recipes_configure
- An array of custom recipe names to be run following a configure
event.
$sel:deploy:Recipes'
, recipes_deploy
- An array of custom recipe names to be run following a deploy
event.
$sel:setup:Recipes'
, recipes_setup
- An array of custom recipe names to be run following a setup
event.
$sel:shutdown:Recipes'
, recipes_shutdown
- An array of custom recipe names to be run following a shutdown
event.
$sel:undeploy:Recipes'
, recipes_undeploy
- An array of custom recipe names to be run following a undeploy
event.
ReportedOs
data ReportedOs Source #
A registered instance's reported operating system.
See: newReportedOs
smart constructor.
Instances
newReportedOs :: ReportedOs Source #
Create a value of ReportedOs
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:family:ReportedOs'
, reportedOs_family
- The operating system family.
$sel:name:ReportedOs'
, reportedOs_name
- The operating system name.
$sel:version:ReportedOs'
, reportedOs_version
- The operating system version.
SelfUserProfile
data SelfUserProfile Source #
Describes a user's SSH information.
See: newSelfUserProfile
smart constructor.
Instances
newSelfUserProfile :: SelfUserProfile Source #
Create a value of SelfUserProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:iamUserArn:SelfUserProfile'
, selfUserProfile_iamUserArn
- The user's IAM ARN.
$sel:name:SelfUserProfile'
, selfUserProfile_name
- The user's name.
$sel:sshPublicKey:SelfUserProfile'
, selfUserProfile_sshPublicKey
- The user's SSH public key.
$sel:sshUsername:SelfUserProfile'
, selfUserProfile_sshUsername
- The user's SSH user name.
ServiceError
data ServiceError Source #
Describes an AWS OpsWorks Stacks service error.
See: newServiceError
smart constructor.
Constructors
ServiceError' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
newServiceError :: ServiceError Source #
Create a value of ServiceError
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:createdAt:ServiceError'
, serviceError_createdAt
- When the error occurred.
$sel:instanceId:ServiceError'
, serviceError_instanceId
- The instance ID.
$sel:message:ServiceError'
, serviceError_message
- A message that describes the error.
$sel:serviceErrorId:ServiceError'
, serviceError_serviceErrorId
- The error ID.
$sel:stackId:ServiceError'
, serviceError_stackId
- The stack ID.
$sel:type':ServiceError'
, serviceError_type
- The error type.
ShutdownEventConfiguration
data ShutdownEventConfiguration Source #
The Shutdown event configuration.
See: newShutdownEventConfiguration
smart constructor.
Constructors
ShutdownEventConfiguration' (Maybe Bool) (Maybe Int) |
Instances
newShutdownEventConfiguration :: ShutdownEventConfiguration Source #
Create a value of ShutdownEventConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:delayUntilElbConnectionsDrained:ShutdownEventConfiguration'
, shutdownEventConfiguration_delayUntilElbConnectionsDrained
- Whether to enable Elastic Load Balancing connection draining. For more
information, see
Connection Draining
$sel:executionTimeout:ShutdownEventConfiguration'
, shutdownEventConfiguration_executionTimeout
- The time, in seconds, that AWS OpsWorks Stacks will wait after
triggering a Shutdown event before shutting down an instance.
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: newSource
smart constructor.
Constructors
Source' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe SourceType) (Maybe Text) (Maybe Text) |
Instances
Create a value of Source
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:password:Source'
, source_password
- When included in a request, the parameter depends on the repository
type.
- For Amazon S3 bundles, set
Password
to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set
Password
to the password.
For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks Stacks returns *****FILTERED*****
instead
of the actual value.
$sel:revision:Source'
, source_revision
- 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.
$sel:sshKey:Source'
, source_sshKey
- In requests, the repository's SSH key.
In responses, AWS OpsWorks Stacks returns *****FILTERED*****
instead
of the actual value.
$sel:type':Source'
, source_type
- The repository type.
$sel:url:Source'
, source_url
- 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
.
$sel:username:Source'
, source_username
- 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.
SslConfiguration
data SslConfiguration Source #
Describes an app's SSL configuration.
See: newSslConfiguration
smart constructor.
Instances
newSslConfiguration :: SslConfiguration Source #
Create a value of SslConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:certificate:SslConfiguration'
, sslConfiguration_certificate
- The contents of the certificate's domain.crt file.
$sel:chain:SslConfiguration'
, sslConfiguration_chain
- Optional. Can be used to specify an intermediate certificate authority
key or client authentication.
$sel:privateKey:SslConfiguration'
, sslConfiguration_privateKey
- The private key; the contents of the certificate's domain.kex file.
Stack
Describes a stack.
See: newStack
smart constructor.
Constructors
Stack' (Maybe Text) (Maybe Text) (Maybe (HashMap StackAttributesKeys (Maybe Text))) (Maybe ChefConfiguration) (Maybe StackConfigurationManager) (Maybe Text) (Maybe Source) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe RootDeviceType) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Bool) (Maybe Text) |
Instances
Create a value of Stack
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:agentVersion:Stack'
, stack_agentVersion
- The agent version. This parameter is set to LATEST
for auto-update. or
a version number for a fixed agent version.
$sel:arn:Stack'
, stack_arn
- The stack's ARN.
$sel:attributes:Stack'
, stack_attributes
- The stack's attributes.
$sel:chefConfiguration:Stack'
, stack_chefConfiguration
- A ChefConfiguration
object that specifies whether to enable Berkshelf
and the Berkshelf version. For more information, see
Create a New Stack.
$sel:configurationManager:Stack'
, stack_configurationManager
- The configuration manager.
$sel:createdAt:Stack'
, stack_createdAt
- The date when the stack was created.
$sel:customCookbooksSource:Stack'
, stack_customCookbooksSource
- Contains the information required to retrieve an app or cookbook from a
repository. For more information, see
Adding Apps
or
Cookbooks and Recipes.
$sel:customJson:Stack'
, stack_customJson
- 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.
$sel:defaultAvailabilityZone:Stack'
, stack_defaultAvailabilityZone
- The stack's default Availability Zone. For more information, see
Regions and Endpoints.
$sel:defaultInstanceProfileArn:Stack'
, stack_defaultInstanceProfileArn
- 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.
$sel:defaultOs:Stack'
, stack_defaultOs
- The stack's default operating system.
$sel:defaultRootDeviceType:Stack'
, stack_defaultRootDeviceType
- 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.
$sel:defaultSshKeyName:Stack'
, stack_defaultSshKeyName
- A default Amazon EC2 key pair for the stack's instances. You can
override this value when you create or update an instance.
$sel:defaultSubnetId:Stack'
, stack_defaultSubnetId
- The default subnet ID; applicable only if the stack is running in a VPC.
$sel:hostnameTheme:Stack'
, stack_hostnameTheme
- The stack host name theme, with spaces replaced by underscores.
Stack
, stack_name
- The stack name.
$sel:region:Stack'
, stack_region
- The stack AWS region, such as "ap-northeast-2". For more information
about AWS regions, see
Regions and Endpoints.
$sel:serviceRoleArn:Stack'
, stack_serviceRoleArn
- The stack AWS Identity and Access Management (IAM) role.
$sel:stackId:Stack'
, stack_stackId
- The stack ID.
$sel:useCustomCookbooks:Stack'
, stack_useCustomCookbooks
- Whether the stack uses custom cookbooks.
$sel:useOpsworksSecurityGroups:Stack'
, stack_useOpsworksSecurityGroups
- Whether the stack automatically associates the AWS OpsWorks Stacks
built-in security groups with the stack's layers.
$sel:vpcId:Stack'
, stack_vpcId
- The VPC ID; applicable only if the stack is running in a VPC.
StackConfigurationManager
data StackConfigurationManager Source #
Describes the configuration manager.
See: newStackConfigurationManager
smart constructor.
Constructors
StackConfigurationManager' (Maybe Text) (Maybe Text) |
Instances
newStackConfigurationManager :: StackConfigurationManager Source #
Create a value of StackConfigurationManager
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:name:StackConfigurationManager'
, stackConfigurationManager_name
- The name. This parameter must be set to "Chef".
$sel:version:StackConfigurationManager'
, stackConfigurationManager_version
- 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: newStackSummary
smart constructor.
Constructors
StackSummary' (Maybe Int) (Maybe Text) (Maybe InstancesCount) (Maybe Int) (Maybe Text) (Maybe Text) |
Instances
newStackSummary :: StackSummary Source #
Create a value of StackSummary
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:appsCount:StackSummary'
, stackSummary_appsCount
- The number of apps.
$sel:arn:StackSummary'
, stackSummary_arn
- The stack's ARN.
$sel:instancesCount:StackSummary'
, stackSummary_instancesCount
- An InstancesCount
object with the number of instances in each status.
$sel:layersCount:StackSummary'
, stackSummary_layersCount
- The number of layers.
$sel:name:StackSummary'
, stackSummary_name
- The stack name.
$sel:stackId:StackSummary'
, stackSummary_stackId
- The stack ID.
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: newTemporaryCredential
smart constructor.
Instances
newTemporaryCredential :: TemporaryCredential Source #
Create a value of TemporaryCredential
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:instanceId:TemporaryCredential'
, temporaryCredential_instanceId
- The instance's AWS OpsWorks Stacks ID.
$sel:password:TemporaryCredential'
, temporaryCredential_password
- The password.
$sel:username:TemporaryCredential'
, temporaryCredential_username
- The user name.
$sel:validForInMinutes:TemporaryCredential'
, temporaryCredential_validForInMinutes
- 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: newTimeBasedAutoScalingConfiguration
smart constructor.
Constructors
TimeBasedAutoScalingConfiguration' (Maybe WeeklyAutoScalingSchedule) (Maybe Text) |
Instances
newTimeBasedAutoScalingConfiguration :: TimeBasedAutoScalingConfiguration Source #
Create a value of TimeBasedAutoScalingConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:autoScalingSchedule:TimeBasedAutoScalingConfiguration'
, timeBasedAutoScalingConfiguration_autoScalingSchedule
- A WeeklyAutoScalingSchedule
object with the instance schedule.
$sel:instanceId:TimeBasedAutoScalingConfiguration'
, timeBasedAutoScalingConfiguration_instanceId
- The instance ID.
UserProfile
data UserProfile Source #
Describes a user's SSH information.
See: newUserProfile
smart constructor.
Instances
newUserProfile :: UserProfile Source #
Create a value of UserProfile
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:allowSelfManagement:UserProfile'
, userProfile_allowSelfManagement
- Whether users can specify their own SSH public key through the My
Settings page. For more information, see
Managing User Permissions.
$sel:iamUserArn:UserProfile'
, userProfile_iamUserArn
- The user's IAM ARN.
$sel:name:UserProfile'
, userProfile_name
- The user's name.
$sel:sshPublicKey:UserProfile'
, userProfile_sshPublicKey
- The user's SSH public key.
$sel:sshUsername:UserProfile'
, userProfile_sshUsername
- The user's SSH user name.
Volume
Describes an instance's Amazon EBS volume.
See: newVolume
smart constructor.
Constructors
Volume' (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Bool) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Text) (Maybe Int) (Maybe Text) (Maybe Text) (Maybe Text) |
Instances
Create a value of Volume
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:availabilityZone:Volume'
, volume_availabilityZone
- The volume Availability Zone. For more information, see
Regions and Endpoints.
$sel:device:Volume'
, volume_device
- The device name.
$sel:ec2VolumeId:Volume'
, volume_ec2VolumeId
- The Amazon EC2 volume ID.
$sel:encrypted:Volume'
, volume_encrypted
- Specifies whether an Amazon EBS volume is encrypted. For more
information, see
Amazon EBS Encryption.
$sel:instanceId:Volume'
, volume_instanceId
- The instance ID.
$sel:iops:Volume'
, volume_iops
- For PIOPS volumes, the IOPS per disk.
$sel:mountPoint:Volume'
, volume_mountPoint
- The volume mount point. For example, "/mnt/disk1".
$sel:name:Volume'
, volume_name
- The volume name.
$sel:raidArrayId:Volume'
, volume_raidArrayId
- The RAID array ID.
$sel:region:Volume'
, volume_region
- The AWS region. For more information about AWS regions, see
Regions and Endpoints.
$sel:size:Volume'
, volume_size
- The volume size.
$sel:status:Volume'
, volume_status
- The value returned by
DescribeVolumes.
$sel:volumeId:Volume'
, volume_volumeId
- The volume ID.
$sel:volumeType:Volume'
, volume_volumeType
- The volume type. For more information, see
Amazon EBS Volume Types.
standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.
VolumeConfiguration
data VolumeConfiguration Source #
Describes an Amazon EBS volume configuration.
See: newVolumeConfiguration
smart constructor.
Instances
newVolumeConfiguration Source #
Arguments
:: Text | |
-> Int | |
-> Int | |
-> VolumeConfiguration |
Create a value of VolumeConfiguration
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:encrypted:VolumeConfiguration'
, volumeConfiguration_encrypted
- Specifies whether an Amazon EBS volume is encrypted. For more
information, see
Amazon EBS Encryption.
$sel:iops:VolumeConfiguration'
, volumeConfiguration_iops
- For PIOPS volumes, the IOPS per disk.
$sel:raidLevel:VolumeConfiguration'
, volumeConfiguration_raidLevel
- The volume
RAID level.
$sel:volumeType:VolumeConfiguration'
, volumeConfiguration_volumeType
- The volume type. For more information, see
Amazon EBS Volume Types.
standard
- Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.io1
- Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.gp2
- General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.st1
- Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.sc1
- Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.
$sel:mountPoint:VolumeConfiguration'
, volumeConfiguration_mountPoint
- The volume mount point. For example "/dev/sdh".
$sel:numberOfDisks:VolumeConfiguration'
, volumeConfiguration_numberOfDisks
- The number of disks in the volume.
$sel:size:VolumeConfiguration'
, volumeConfiguration_size
- 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: newWeeklyAutoScalingSchedule
smart constructor.
Constructors
WeeklyAutoScalingSchedule' (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) (Maybe (HashMap Text Text)) |
Instances
newWeeklyAutoScalingSchedule :: WeeklyAutoScalingSchedule Source #
Create a value of WeeklyAutoScalingSchedule
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
$sel:friday:WeeklyAutoScalingSchedule'
, weeklyAutoScalingSchedule_friday
- The schedule for Friday.
$sel:monday:WeeklyAutoScalingSchedule'
, weeklyAutoScalingSchedule_monday
- The schedule for Monday.
$sel:saturday:WeeklyAutoScalingSchedule'
, weeklyAutoScalingSchedule_saturday
- The schedule for Saturday.
$sel:sunday:WeeklyAutoScalingSchedule'
, weeklyAutoScalingSchedule_sunday
- The schedule for Sunday.
$sel:thursday:WeeklyAutoScalingSchedule'
, weeklyAutoScalingSchedule_thursday
- The schedule for Thursday.
$sel:tuesday:WeeklyAutoScalingSchedule'
, weeklyAutoScalingSchedule_tuesday
- The schedule for Tuesday.
$sel:wednesday:WeeklyAutoScalingSchedule'
, weeklyAutoScalingSchedule_wednesday
- The schedule for Wednesday.