Network.AWS.OpsWorks.UpdateStack

Updates a specified stack.

Required Permissions : To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions .

Creating a Request

updateStack

Arguments

:: Text

usStackId

-> UpdateStack

Creates a value of UpdateStack with the minimum fields required to make a request.

Use one of the following lenses to modify other fields as desired:

• usDefaultInstanceProfileARN - 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 .
• usServiceRoleARN - Do not use this parameter. You cannot update a stack's service role.
• usDefaultRootDeviceType - 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 .
• usChefConfiguration - 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 .
• usAgentVersion - The default AWS OpsWorks agent version. You have the following options: * Auto-update - Set this parameter to LATEST . AWS OpsWorks 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 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 .
• usDefaultSSHKeyName - 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 .
• usCustomJSON - 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 on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes .
• usCustomCookbooksSource - Undocumented member.
• usDefaultAvailabilityZone - 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 .
• usAttributes - One or more user-defined key-value pairs to be added to the stack attributes.
• usName - The stack's new name.
• usDefaultOS - 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 2016.03 , Amazon Linux 2015.09 , or Amazon Linux 2015.03 . * A supported Ubuntu operating system, such as Ubuntu 16.04 LTS , Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS . * CentOS 7 * Red Hat Enterprise Linux 7 * A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft Windows Server 2012 R2 with SQL Server Web . * A custom AMI: Custom . You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs . The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems .
• usUseOpsworksSecurityGroups - Whether to associate the AWS OpsWorks built-in security groups with the stack's layers. AWS OpsWorks 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 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 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 .
• usUseCustomCookbooks - Whether the stack uses custom cookbooks.
• usDefaultSubnetId - 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.
• usConfigurationManager - 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 11.4.
• usHostnameTheme - 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 * 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.
• usStackId - The stack ID.

data UpdateStack

See: updateStack smart constructor.

Instances

Eq UpdateStack

Methods

(==) :: UpdateStack -> UpdateStack -> Bool

(/=) :: UpdateStack -> UpdateStack -> Bool

Data UpdateStack

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateStack -> c UpdateStack

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateStack

toConstr :: UpdateStack -> Constr

dataTypeOf :: UpdateStack -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStack)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateStack)

gmapT :: (forall b. Data b => b -> b) -> UpdateStack -> UpdateStack

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStack -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStack -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateStack -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateStack -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateStack -> m UpdateStack

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStack -> m UpdateStack

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStack -> m UpdateStack

Read UpdateStack

Methods

readsPrec :: Int -> ReadS UpdateStack

readList :: ReadS [UpdateStack]

readPrec :: ReadPrec UpdateStack

readListPrec :: ReadPrec [UpdateStack]

Show UpdateStack

Methods

showsPrec :: Int -> UpdateStack -> ShowS

show :: UpdateStack -> String

showList :: [UpdateStack] -> ShowS

Generic UpdateStack

Associated Types

type Rep UpdateStack :: * -> *

Methods

from :: UpdateStack -> Rep UpdateStack x

to :: Rep UpdateStack x -> UpdateStack

Hashable UpdateStack

Methods

hashWithSalt :: Int -> UpdateStack -> Int

hash :: UpdateStack -> Int

ToJSON UpdateStack

Methods

toJSON :: UpdateStack -> Value

toEncoding :: UpdateStack -> Encoding

toJSONList :: [UpdateStack] -> Value

toEncodingList :: [UpdateStack] -> Encoding

NFData UpdateStack

Methods

rnf :: UpdateStack -> ()

AWSRequest UpdateStack

Associated Types

type Rs UpdateStack :: *

Methods

request :: UpdateStack -> Request UpdateStack

response :: MonadResource m => Logger -> Service -> Proxy * UpdateStack -> ClientResponse -> m (Response UpdateStack)

ToPath UpdateStack

Methods

toPath :: UpdateStack -> ByteString

ToHeaders UpdateStack

Methods

toHeaders :: UpdateStack -> [Header]

ToQuery UpdateStack

Methods

toQuery :: UpdateStack -> QueryString

type Rep UpdateStack

type Rep UpdateStack = D1 (MetaData "UpdateStack" "Network.AWS.OpsWorks.UpdateStack" "amazonka-opsworks-1.4.5-7XI4vLMXIJB3lyxy2oXKSd" False) (C1 (MetaCons "UpdateStack'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_usDefaultInstanceProfileARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_usServiceRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_usDefaultRootDeviceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RootDeviceType))) (S1 (MetaSel (Just Symbol "_usChefConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ChefConfiguration))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_usAgentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_usDefaultSSHKeyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_usCustomJSON") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) ((:*:) (S1 (MetaSel (Just Symbol "_usCustomCookbooksSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Source))) (S1 (MetaSel (Just Symbol "_usDefaultAvailabilityZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_usAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map StackAttributesKeys Text)))) (S1 (MetaSel (Just Symbol "_usName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_usDefaultOS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_usUseOpsworksSecurityGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_usUseCustomCookbooks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) (S1 (MetaSel (Just Symbol "_usDefaultSubnetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_usConfigurationManager") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StackConfigurationManager))) ((:*:) (S1 (MetaSel (Just Symbol "_usHostnameTheme") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_usStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))))

type Rs UpdateStack

type Rs UpdateStack = UpdateStackResponse

Request Lenses

usDefaultInstanceProfileARN :: Lens' UpdateStack (Maybe Text)

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 .

usServiceRoleARN :: Lens' UpdateStack (Maybe Text)

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

usDefaultRootDeviceType :: Lens' UpdateStack (Maybe RootDeviceType)

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 .

usChefConfiguration :: Lens' UpdateStack (Maybe 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 .

usAgentVersion :: Lens' UpdateStack (Maybe Text)

The default AWS OpsWorks agent version. You have the following options: * Auto-update - Set this parameter to LATEST . AWS OpsWorks 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 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 .

usDefaultSSHKeyName :: Lens' UpdateStack (Maybe Text)

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 .

usCustomJSON :: Lens' UpdateStack (Maybe Text)

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 on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes .

usCustomCookbooksSource :: Lens' UpdateStack (Maybe Source)

Undocumented member.

usDefaultAvailabilityZone :: Lens' UpdateStack (Maybe Text)

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 .

usAttributes :: Lens' UpdateStack (HashMap StackAttributesKeys Text)

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

usName :: Lens' UpdateStack (Maybe Text)

The stack's new name.

usDefaultOS :: Lens' UpdateStack (Maybe Text)

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 2016.03 , Amazon Linux 2015.09 , or Amazon Linux 2015.03 . * A supported Ubuntu operating system, such as Ubuntu 16.04 LTS , Ubuntu 14.04 LTS , or Ubuntu 12.04 LTS . * CentOS 7 * Red Hat Enterprise Linux 7 * A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base , Microsoft Windows Server 2012 R2 with SQL Server Express , Microsoft Windows Server 2012 R2 with SQL Server Standard , or Microsoft Windows Server 2012 R2 with SQL Server Web . * A custom AMI: Custom . You specify the custom AMI you want to use when you create instances. For more information on how to use custom AMIs with OpsWorks, see Using Custom AMIs . The default option is the stack's current operating system. For more information on the supported operating systems, see AWS OpsWorks Operating Systems .

usUseOpsworksSecurityGroups :: Lens' UpdateStack (Maybe Bool)

Whether to associate the AWS OpsWorks built-in security groups with the stack's layers. AWS OpsWorks 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 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 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 .

usUseCustomCookbooks :: Lens' UpdateStack (Maybe Bool)

Whether the stack uses custom cookbooks.

usDefaultSubnetId :: Lens' UpdateStack (Maybe Text)

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.

usConfigurationManager :: Lens' UpdateStack (Maybe StackConfigurationManager)

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

usHostnameTheme :: Lens' UpdateStack (Maybe Text)

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

usStackId :: Lens' UpdateStack Text

The stack ID.

Destructuring the Response

updateStackResponse :: UpdateStackResponse

Creates a value of UpdateStackResponse with the minimum fields required to make a request.

data UpdateStackResponse

See: updateStackResponse smart constructor.

Instances

Eq UpdateStackResponse

Methods

(==) :: UpdateStackResponse -> UpdateStackResponse -> Bool

(/=) :: UpdateStackResponse -> UpdateStackResponse -> Bool

Data UpdateStackResponse

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UpdateStackResponse -> c UpdateStackResponse

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UpdateStackResponse

toConstr :: UpdateStackResponse -> Constr

dataTypeOf :: UpdateStackResponse -> DataType

dataCast1 :: Typeable (* -> *) t => (forall d. Data d => c (t d)) -> Maybe (c UpdateStackResponse)

dataCast2 :: Typeable (* -> * -> *) t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UpdateStackResponse)

gmapT :: (forall b. Data b => b -> b) -> UpdateStackResponse -> UpdateStackResponse

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStackResponse -> r

gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UpdateStackResponse -> r

gmapQ :: (forall d. Data d => d -> u) -> UpdateStackResponse -> [u]

gmapQi :: Int -> (forall d. Data d => d -> u) -> UpdateStackResponse -> u

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UpdateStackResponse -> m UpdateStackResponse

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStackResponse -> m UpdateStackResponse

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UpdateStackResponse -> m UpdateStackResponse

Read UpdateStackResponse

Methods

readsPrec :: Int -> ReadS UpdateStackResponse

readList :: ReadS [UpdateStackResponse]

readPrec :: ReadPrec UpdateStackResponse

readListPrec :: ReadPrec [UpdateStackResponse]

Show UpdateStackResponse

Methods

showsPrec :: Int -> UpdateStackResponse -> ShowS

show :: UpdateStackResponse -> String

showList :: [UpdateStackResponse] -> ShowS

Generic UpdateStackResponse

Associated Types

type Rep UpdateStackResponse :: * -> *

Methods

from :: UpdateStackResponse -> Rep UpdateStackResponse x

to :: Rep UpdateStackResponse x -> UpdateStackResponse

NFData UpdateStackResponse

Methods

rnf :: UpdateStackResponse -> ()

type Rep UpdateStackResponse

type Rep UpdateStackResponse = D1 (MetaData "UpdateStackResponse" "Network.AWS.OpsWorks.UpdateStack" "amazonka-opsworks-1.4.5-7XI4vLMXIJB3lyxy2oXKSd" False) (C1 (MetaCons "UpdateStackResponse'" PrefixI False) U1)