Copyright | (c) 2013-2015 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | None |
Language | Haskell2010 |
Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent 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.
See: AWS API Reference for CloneStack.
- cloneStack :: Text -> Text -> CloneStack
- data CloneStack
- cCloneAppIds :: Lens' CloneStack [Text]
- cDefaultInstanceProfileARN :: Lens' CloneStack (Maybe Text)
- cDefaultRootDeviceType :: Lens' CloneStack (Maybe RootDeviceType)
- cChefConfiguration :: Lens' CloneStack (Maybe ChefConfiguration)
- cVPCId :: Lens' CloneStack (Maybe Text)
- cAgentVersion :: Lens' CloneStack (Maybe Text)
- cDefaultSSHKeyName :: Lens' CloneStack (Maybe Text)
- cCustomJSON :: Lens' CloneStack (Maybe Text)
- cClonePermissions :: Lens' CloneStack (Maybe Bool)
- cCustomCookbooksSource :: Lens' CloneStack (Maybe Source)
- cDefaultAvailabilityZone :: Lens' CloneStack (Maybe Text)
- cName :: Lens' CloneStack (Maybe Text)
- cUseOpsworksSecurityGroups :: Lens' CloneStack (Maybe Bool)
- cDefaultOS :: Lens' CloneStack (Maybe Text)
- cAttributes :: Lens' CloneStack (HashMap StackAttributesKeys Text)
- cUseCustomCookbooks :: Lens' CloneStack (Maybe Bool)
- cDefaultSubnetId :: Lens' CloneStack (Maybe Text)
- cRegion :: Lens' CloneStack (Maybe Text)
- cConfigurationManager :: Lens' CloneStack (Maybe StackConfigurationManager)
- cHostnameTheme :: Lens' CloneStack (Maybe Text)
- cSourceStackId :: Lens' CloneStack Text
- cServiceRoleARN :: Lens' CloneStack Text
- cloneStackResponse :: Int -> CloneStackResponse
- data CloneStackResponse
- csrsStackId :: Lens' CloneStackResponse (Maybe Text)
- csrsStatus :: Lens' CloneStackResponse Int
Creating a Request
Creates a value of CloneStack
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
cCloneAppIds
cDefaultInstanceProfileARN
cDefaultRootDeviceType
cChefConfiguration
cVPCId
cAgentVersion
cDefaultSSHKeyName
cCustomJSON
cClonePermissions
cCustomCookbooksSource
cDefaultAvailabilityZone
cName
cUseOpsworksSecurityGroups
cDefaultOS
cAttributes
cUseCustomCookbooks
cDefaultSubnetId
cRegion
cConfigurationManager
cHostnameTheme
cSourceStackId
cServiceRoleARN
data CloneStack Source
See: cloneStack
smart constructor.
Request Lenses
cCloneAppIds :: Lens' CloneStack [Text] Source
A list of source stack app IDs to be included in the cloned stack.
cDefaultInstanceProfileARN :: Lens' CloneStack (Maybe Text) Source
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.
cDefaultRootDeviceType :: Lens' CloneStack (Maybe RootDeviceType) Source
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.
cChefConfiguration :: Lens' CloneStack (Maybe ChefConfiguration) Source
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.
cVPCId :: Lens' CloneStack (Maybe Text) Source
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 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.
cAgentVersion :: Lens' CloneStack (Maybe Text) Source
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.
You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.
cDefaultSSHKeyName :: Lens' CloneStack (Maybe Text) Source
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.
cCustomJSON :: Lens' CloneStack (Maybe Text) Source
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 and must escape characters such as '"':
'"{\"key1\": \"value1\", \"key2\": \"value2\",...}"'
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes
cClonePermissions :: Lens' CloneStack (Maybe Bool) Source
Whether to clone the source stack's permissions.
cCustomCookbooksSource :: Lens' CloneStack (Maybe Source) Source
Undocumented member.
cDefaultAvailabilityZone :: Lens' CloneStack (Maybe Text) Source
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.
cUseOpsworksSecurityGroups :: Lens' CloneStack (Maybe Bool) Source
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 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.
cDefaultOS :: Lens' CloneStack (Maybe Text) Source
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 2015.03', 'Red Hat Enterprise Linux 7', 'Ubuntu 12.04 LTS', or 'Ubuntu 14.04 LTS'.
- 'Microsoft Windows Server 2012 R2 Base'.
- 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 parent stack's operating system. For more information on the supported operating systems, see AWS OpsWorks 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.
cAttributes :: Lens' CloneStack (HashMap StackAttributesKeys Text) Source
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
cUseCustomCookbooks :: Lens' CloneStack (Maybe Bool) Source
Whether to use custom cookbooks.
cDefaultSubnetId :: Lens' CloneStack (Maybe Text) Source
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.
cRegion :: Lens' CloneStack (Maybe Text) Source
The cloned stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
cConfigurationManager :: Lens' CloneStack (Maybe StackConfigurationManager) Source
The configuration manager. When you clone a Linux stack we recommend that you use the configuration manager to specify the Chef version: 0.9, 11.4, or 11.10. The default value is currently 11.10.
cHostnameTheme :: Lens' CloneStack (Maybe Text) Source
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
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.
cSourceStackId :: Lens' CloneStack Text Source
The source stack ID.
cServiceRoleARN :: Lens' CloneStack Text Source
The stack 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. If you create a stack by using the AWS OpsWorks 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.
Destructuring the Response
Creates a value of CloneStackResponse
with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
data CloneStackResponse Source
Contains the response to a CloneStack
request.
See: cloneStackResponse
smart constructor.
Response Lenses
csrsStackId :: Lens' CloneStackResponse (Maybe Text) Source
The cloned stack ID.
csrsStatus :: Lens' CloneStackResponse Int Source
The response status code.