AWS SDK for .NET Documentation
CloneStackRequest Class
AmazonAmazon.OpsWorks.ModelCloneStackRequest Did this page help you?   Yes   No    Tell us about it...
Container for the parameters to the CloneStack operation. Creates a clone of a specified stack. For more information, see Clone a 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.

Declaration Syntax
C#
public class CloneStackRequest : AmazonWebServiceRequest
Members
All MembersConstructorsMethodsProperties



IconMemberDescription
CloneStackRequest()()()()
Initializes a new instance of the CloneStackRequest class

Attributes
Gets and sets the property Attributes.

A list of stack attributes and values as key/value pairs to be added to the cloned stack.


ChefConfiguration
Gets and sets the property ChefConfiguration.

A

CopyC#
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
Gets and sets the property CloneAppIds.

A list of source stack app IDs to be included in the cloned stack.


ClonePermissions
Gets and sets the property ClonePermissions.

Whether to clone the source stack's permissions.


ConfigurationManager
Gets and sets the property ConfigurationManager.

The configuration manager. When you clone a 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.4.


CustomCookbooksSource
Gets and sets the property CustomCookbooksSource.

CustomJson
Gets and sets the property 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 and must escape characters such as '"'.:

CopyC#
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

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


DefaultAvailabilityZone
Gets and sets the property 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

CopyC#
DefaultSubnetId
, the subnet must be in the same zone. For more information, see the
CopyC#
VpcId
parameter description.


DefaultInstanceProfileArn
Gets and sets the property 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.


DefaultOs
Gets and sets the property DefaultOs.

The cloned stack's default operating system, which must be set to

CopyC#
Amazon Linux
or
CopyC#
Ubuntu 12.04 LTS
. The default option is
CopyC#
Amazon Linux
.


DefaultRootDeviceType
Gets and sets the property 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.


DefaultSshKeyName
Gets and sets the property DefaultSshKeyName.

A default SSH key for the stack instances. You can override this value when you create or update an instance.


DefaultSubnetId
Gets and sets the property DefaultSubnetId.

The stack's default subnet ID. All instances will be launched into this subnet unless you specify otherwise when you create the instance. If you also specify a value for

CopyC#
DefaultAvailabilityZone
, the subnet must be in the same zone. For information on default values and when this parameter is required, see the
CopyC#
VpcId
parameter description.


Equals(Object)
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
GetHashCode()()()()
Serves as a hash function for a particular type.
(Inherited from Object.)
GetType()()()()
Gets the type of the current instance.
(Inherited from Object.)
HostnameTheme
Gets and sets the property 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,

CopyC#
HostnameTheme
is set to
CopyC#
Layer_Dependent
, which creates host names by appending integers to the layer's short name. The other themes are:

  • CopyC#
    Baked_Goods
  • CopyC#
    Clouds
  • CopyC#
    European_Cities
  • CopyC#
    Fruits
  • CopyC#
    Greek_Deities
  • CopyC#
    Legendary_Creatures_from_Japan
  • CopyC#
    Planets_and_Moons
  • CopyC#
    Roman_Deities
  • CopyC#
    Scottish_Islands
  • CopyC#
    US_Cities
  • CopyC#
    Wild_Cats

To obtain a generated host name, call

CopyC#
GetHostNameSuggestion
, which returns a host name based on the current theme.


Name
Gets and sets the property Name.

The cloned stack name.


Region
Gets and sets the property Region.

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


ServiceRoleArn
Gets and sets the property ServiceRoleArn.

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.

Note:

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.


SourceStackId
Gets and sets the property SourceStackId.

The source stack ID.


ToString()()()()
Returns a string that represents the current object.
(Inherited from Object.)
UseCustomCookbooks
Gets and sets the property UseCustomCookbooks.

Whether to use custom cookbooks.


UseOpsworksSecurityGroups
Gets and sets the property UseOpsworksSecurityGroups.

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

CopyC#
UseOpsworksSecurityGroups
you can instead provide your own custom security groups.
CopyC#
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.


VpcId
Gets and sets the property VpcId.

The ID of the VPC that the cloned stack is to be launched into. It must be in the specified region. All instances will be 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

CopyC#
DefaultAvailabilityZone
or the
CopyC#
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
    CopyC#
    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.


WithAttributes(array<KeyValuePair<(Of <<'(String, String>)>>)>[]()[][]) Obsolete.
Adds the KeyValuePairs to the Attributes dictionary.

WithChefConfiguration(ChefConfiguration) Obsolete.
Sets the ChefConfiguration property

WithCloneAppIds(array<String>[]()[][]) Obsolete.
Sets the CloneAppIds property

WithCloneAppIds(IEnumerable<(Of <<'(String>)>>)) Obsolete.
Sets the CloneAppIds property

WithClonePermissions(Boolean) Obsolete.
Sets the ClonePermissions property

WithConfigurationManager(StackConfigurationManager) Obsolete.
Sets the ConfigurationManager property

WithCustomCookbooksSource(Source) Obsolete.
Sets the CustomCookbooksSource property

WithCustomJson(String) Obsolete.
Sets the CustomJson property

WithDefaultAvailabilityZone(String) Obsolete.
Sets the DefaultAvailabilityZone property

WithDefaultInstanceProfileArn(String) Obsolete.
Sets the DefaultInstanceProfileArn property

WithDefaultOs(String) Obsolete.
Sets the DefaultOs property

WithDefaultRootDeviceType(String) Obsolete.
Sets the DefaultRootDeviceType property

WithDefaultSshKeyName(String) Obsolete.
Sets the DefaultSshKeyName property

WithDefaultSubnetId(String) Obsolete.
Sets the DefaultSubnetId property

WithHostnameTheme(String) Obsolete.
Sets the HostnameTheme property

WithName(String) Obsolete.
Sets the Name property

WithRegion(String) Obsolete.
Sets the Region property

WithServiceRoleArn(String) Obsolete.
Sets the ServiceRoleArn property

WithSourceStackId(String) Obsolete.
Sets the SourceStackId property

WithUseCustomCookbooks(Boolean) Obsolete.
Sets the UseCustomCookbooks property

WithUseOpsworksSecurityGroups(Boolean) Obsolete.
Sets the UseOpsworksSecurityGroups property

WithVpcId(String) Obsolete.
Sets the VpcId property

Inheritance Hierarchy

Assembly: AWSSDK (Module: AWSSDK) Version: 1.5.60.0 (1.5.60.0)