Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages


home | help
Paws::OpsWorks::CloneSUser(Contributed Perl DocumPaws::OpsWorks::CloneStack(3)

       Paws::OpsWorks::CloneStack - Arguments for method CloneStack on

       This class represents the parameters used for calling the method
       CloneStack on the AWS OpsWorks service. Use the attributes of this
       class as	arguments to method CloneStack.

       You shouln't make instances of this class. Each attribute should	be
       used as a named argument	in the call to CloneStack.

       As an example:

	 $service_obj->CloneStack(Att1 => $value1, Att2	=> $value2, ...);

       Values for attributes that are native types (Int, String, Float,	etc)
       can passed as-is	(scalar	values). Values	for complex Types (objects)
       can be passed as	a HashRef. The keys and	values of the hashref will be
       used to instance	the underlying object.

   AgentVersion	=> Str
       The default AWS OpsWorks	agent version. You have	the following options:

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

       o   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

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

   Attributes => Paws::OpsWorks::StackAttributes
       A list of stack attributes and values as	key/value pairs	to be added to
       the cloned stack.

   ChefConfiguration =>	Paws::OpsWorks::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.

   CloneAppIds => ArrayRef[Str]
       A list of source	stack app IDs to be included in	the cloned stack.

   ClonePermissions => Bool
       Whether to clone	the source stack's permissions.

   ConfigurationManager	=> Paws::OpsWorks::StackConfigurationManager
       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.

   CustomCookbooksSource => Paws::OpsWorks::Source
   CustomJson => Str
       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

   DefaultAvailabilityZone => Str
       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

   DefaultInstanceProfileArn =>	Str
       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.

   DefaultOs =>	Str
       The stack's operating system, which must	be set to one of the

       o   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".

       o   "Microsoft Windows Server 2012 R2 Base".

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

   DefaultRootDeviceType => Str
       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.

   DefaultSshKeyName =>	Str
       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

   DefaultSubnetId => Str
       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.

   HostnameTheme => Str
       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:

       o   "Baked_Goods"

       o   "Clouds"

       o   "Europe_Cities"

       o   "Fruits"

       o   "Greek_Deities"

       o   "Legendary_creatures_from_Japan"

       o   "Planets_and_Moons"

       o   "Roman_Deities"

       o   "Scottish_Islands"

       o   "US_Cities"

       o   "Wild_Cats"

       To obtain a generated host name,	call "GetHostNameSuggestion", which
       returns a host name based on the	current	theme.

   Name	=> Str
       The cloned stack	name.

   Region => Str
       The cloned stack	AWS region, such as "us-east-1". For more information
       about AWS regions, see Regions and Endpoints.

   REQUIRED ServiceRoleArn => Str
       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.

   REQUIRED SourceStackId => Str
       The source stack	ID.

   UseCustomCookbooks => Bool
       Whether to use custom cookbooks.

   UseOpsworksSecurityGroups =>	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

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

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

   VpcId => Str
       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.

       o   If your account supports EC2	Classic, the default value is no VPC.

       o   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:

       o   It must belong to a VPC in your account that	is in the specified

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

       This class forms	part of	Paws, documenting arguments for	method
       CloneStack in Paws::OpsWorks

       The source code is located here:

       Please report bugs to:

perl v5.24.1			  2015-08-06	 Paws::OpsWorks::CloneStack(3)


Want to link to this manual page? Use this URL:

home | help