Network.AWS.OpsWorks.CreateStack

Creates a new stack. For more information, see Create a New Stack.

Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Creating a Request

createStack

Arguments

:: Text

csName

-> Text

csRegion

-> Text

csServiceRoleARN

-> Text

csDefaultInstanceProfileARN

-> CreateStack

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

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

• csDefaultRootDeviceType
• csVPCId
• csChefConfiguration
• csAgentVersion
• csDefaultSSHKeyName
• csCustomJSON
• csCustomCookbooksSource
• csDefaultAvailabilityZone
• csAttributes
• csDefaultOS
• csUseOpsworksSecurityGroups
• csUseCustomCookbooks
• csDefaultSubnetId
• csConfigurationManager
• csHostnameTheme
• csName
• csRegion
• csServiceRoleARN
• csDefaultInstanceProfileARN

data CreateStack

See: createStack smart constructor.

Instances

Eq CreateStack

Methods

(==) :: CreateStack -> CreateStack -> Bool

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

Data CreateStack

Methods

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

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

toConstr :: CreateStack -> Constr

dataTypeOf :: CreateStack -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateStack

Methods

readsPrec :: Int -> ReadS CreateStack

readList :: ReadS [CreateStack]

readPrec :: ReadPrec CreateStack

readListPrec :: ReadPrec [CreateStack]

Show CreateStack

Methods

showsPrec :: Int -> CreateStack -> ShowS

show :: CreateStack -> String

showList :: [CreateStack] -> ShowS

Generic CreateStack

Associated Types

type Rep CreateStack :: * -> *

Methods

from :: CreateStack -> Rep CreateStack x

to :: Rep CreateStack x -> CreateStack

Hashable CreateStack

Methods

hashWithSalt :: Int -> CreateStack -> Int

hash :: CreateStack -> Int

NFData CreateStack

Methods

rnf :: CreateStack -> ()

AWSRequest CreateStack

Associated Types

type Rs CreateStack :: *

Methods

request :: CreateStack -> Request CreateStack

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

ToPath CreateStack

Methods

toPath :: CreateStack -> ByteString

ToHeaders CreateStack

Methods

toHeaders :: CreateStack -> [Header]

ToQuery CreateStack

Methods

toQuery :: CreateStack -> QueryString

ToJSON CreateStack

Methods

toJSON :: CreateStack -> Value

toEncoding :: CreateStack -> Encoding

type Rep CreateStack

type Rep CreateStack = D1 (MetaData "CreateStack" "Network.AWS.OpsWorks.CreateStack" "amazonka-opsworks-1.4.4-n3dv83EUzf7afH3Q1jxrM" False) (C1 (MetaCons "CreateStack'" PrefixI True) ((:*:) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csDefaultRootDeviceType") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe RootDeviceType))) (S1 (MetaSel (Just Symbol "_csVPCId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csChefConfiguration") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe ChefConfiguration))) (S1 (MetaSel (Just Symbol "_csAgentVersion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csDefaultSSHKeyName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csCustomJSON") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text)))) ((:*:) (S1 (MetaSel (Just Symbol "_csCustomCookbooksSource") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Source))) ((:*:) (S1 (MetaSel (Just Symbol "_csDefaultAvailabilityZone") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csAttributes") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe (Map StackAttributesKeys Text)))))))) ((:*:) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csDefaultOS") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csUseOpsworksSecurityGroups") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool)))) ((:*:) (S1 (MetaSel (Just Symbol "_csUseCustomCookbooks") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Bool))) ((:*:) (S1 (MetaSel (Just Symbol "_csDefaultSubnetId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csConfigurationManager") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe StackConfigurationManager)))))) ((:*:) ((:*:) (S1 (MetaSel (Just Symbol "_csHostnameTheme") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_csName") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))) ((:*:) (S1 (MetaSel (Just Symbol "_csRegion") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) ((:*:) (S1 (MetaSel (Just Symbol "_csServiceRoleARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text)) (S1 (MetaSel (Just Symbol "_csDefaultInstanceProfileARN") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 Text))))))))

type Rs CreateStack

type Rs CreateStack = CreateStackResponse

Request Lenses

csDefaultRootDeviceType :: Lens' CreateStack (Maybe RootDeviceType)

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.

csVPCId :: Lens' CreateStack (Maybe Text)

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 infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks 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 on how to use AWS OpsWorks with a VPC, see Running a Stack in a VPC. For more information on default VPC and EC2-Classic, see Supported Platforms.

csChefConfiguration :: Lens' CreateStack (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.

csAgentVersion :: Lens' CreateStack (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 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.

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

csDefaultSSHKeyName :: Lens' CreateStack (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.

csCustomJSON :: Lens' CreateStack (Maybe Text)

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 escape characters such as '"':

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

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

csCustomCookbooksSource :: Lens' CreateStack (Maybe Source)

Undocumented member.

csDefaultAvailabilityZone :: Lens' CreateStack (Maybe Text)

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.

csAttributes :: Lens' CreateStack (HashMap StackAttributesKeys Text)

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

csDefaultOS :: Lens' CreateStack (Maybe Text)

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 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, see Using Custom AMIs.

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

csUseOpsworksSecurityGroups :: Lens' CreateStack (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. With UseOpsworksSecurityGroups you can instead provide your own custom security 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 creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack.

csUseCustomCookbooks :: Lens' CreateStack (Maybe Bool)

Whether the stack uses custom cookbooks.

csDefaultSubnetId :: Lens' CreateStack (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.

csConfigurationManager :: Lens' CreateStack (Maybe StackConfigurationManager)

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

csHostnameTheme :: Lens' CreateStack (Maybe Text)

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

csName :: Lens' CreateStack Text

The stack name.

csRegion :: Lens' CreateStack Text

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

csServiceRoleARN :: Lens' CreateStack Text

The stack's AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks 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.

csDefaultInstanceProfileARN :: Lens' CreateStack Text

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.

Destructuring the Response

createStackResponse

Arguments

:: Int

crsResponseStatus

-> CreateStackResponse

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

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

• crsStackId
• crsResponseStatus

data CreateStackResponse

Contains the response to a CreateStack request.

See: createStackResponse smart constructor.

Instances

Eq CreateStackResponse

Methods

(==) :: CreateStackResponse -> CreateStackResponse -> Bool

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

Data CreateStackResponse

Methods

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

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

toConstr :: CreateStackResponse -> Constr

dataTypeOf :: CreateStackResponse -> DataType

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

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

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

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

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

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

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

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

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

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

Read CreateStackResponse

Methods

readsPrec :: Int -> ReadS CreateStackResponse

readList :: ReadS [CreateStackResponse]

readPrec :: ReadPrec CreateStackResponse

readListPrec :: ReadPrec [CreateStackResponse]

Show CreateStackResponse

Methods

showsPrec :: Int -> CreateStackResponse -> ShowS

show :: CreateStackResponse -> String

showList :: [CreateStackResponse] -> ShowS

Generic CreateStackResponse

Associated Types

type Rep CreateStackResponse :: * -> *

Methods

from :: CreateStackResponse -> Rep CreateStackResponse x

to :: Rep CreateStackResponse x -> CreateStackResponse

NFData CreateStackResponse

Methods

rnf :: CreateStackResponse -> ()

type Rep CreateStackResponse

type Rep CreateStackResponse = D1 (MetaData "CreateStackResponse" "Network.AWS.OpsWorks.CreateStack" "amazonka-opsworks-1.4.4-n3dv83EUzf7afH3Q1jxrM" False) (C1 (MetaCons "CreateStackResponse'" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "_crsStackId") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe Text))) (S1 (MetaSel (Just Symbol "_crsResponseStatus") NoSourceUnpackedness SourceStrict DecidedUnpack) (Rec0 Int))))

Response Lenses

crsStackId :: Lens' CreateStackResponse (Maybe Text)

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

crsResponseStatus :: Lens' CreateStackResponse Int

The response status code.