OpsWorks / Client / clone_stack

clone_stack#

OpsWorks.Client.clone_stack(**kwargs)#

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 about user permissions, see Managing User Permissions.

See also: AWS API Documentation

Request Syntax

response = client.clone_stack(
    SourceStackId='string',
    Name='string',
    Region='string',
    VpcId='string',
    Attributes={
        'string': 'string'
    },
    ServiceRoleArn='string',
    DefaultInstanceProfileArn='string',
    DefaultOs='string',
    HostnameTheme='string',
    DefaultAvailabilityZone='string',
    DefaultSubnetId='string',
    CustomJson='string',
    ConfigurationManager={
        'Name': 'string',
        'Version': 'string'
    },
    ChefConfiguration={
        'ManageBerkshelf': True|False,
        'BerkshelfVersion': 'string'
    },
    UseCustomCookbooks=True|False,
    UseOpsworksSecurityGroups=True|False,
    CustomCookbooksSource={
        'Type': 'git'|'svn'|'archive'|'s3',
        'Url': 'string',
        'Username': 'string',
        'Password': 'string',
        'SshKey': 'string',
        'Revision': 'string'
    },
    DefaultSshKeyName='string',
    ClonePermissions=True|False,
    CloneAppIds=[
        'string',
    ],
    DefaultRootDeviceType='ebs'|'instance-store',
    AgentVersion='string'
)
Parameters:

  • SourceStackId (string) –

    [REQUIRED]

    The source stack ID.

  • Name (string) – The cloned stack name. Stack names can be a maximum of 64 characters.

  • Region (string) – The cloned stack Amazon Web Services Region, such as ap-northeast-2. For more information about Amazon Web Services Regions, see Regions and Endpoints.

  • VpcId (string) –

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

  • Attributes (dict) –

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

    • (string) –

      • (string) –

  • ServiceRoleArn (string) –

    [REQUIRED]

    The stack Identity and Access Management (IAM) role, which allows OpsWorks Stacks to work with Amazon Web Services 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 OpsWorkss Stacks 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.

  • DefaultInstanceProfileArn (string) – 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 (string) –

    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 2, Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

    • A supported Ubuntu operating system, such as Ubuntu 18.04 LTS, Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

    • CentOS Linux 7

    • Red Hat Enterprise Linux 7

    • 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 about how to use custom AMIs with OpsWorks, see Using Custom AMIs.

    The default option is the parent stack’s operating system. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see OpsWorks Stacks Operating Systems.

    Note

    You can specify a different Linux operating system for the cloned stack, but you cannot change from Linux to Windows or Windows to Linux.

  • HostnameTheme (string) –

    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_and_Titans

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

  • DefaultAvailabilityZone (string) – 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.

  • DefaultSubnetId (string) – 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.

  • CustomJson (string) –

    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:

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

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

  • ConfigurationManager (dict) –

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

    • Name (string) –

      The name. This parameter must be set to Chef.

    • Version (string) –

      The Chef version. This parameter must be set to 12, 11.10, or 11.4 for Linux stacks, and to 12.2 for Windows stacks. The default value for Linux stacks is 12.

  • ChefConfiguration (dict) –

    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.

    • ManageBerkshelf (boolean) –

      Whether to enable Berkshelf.

    • BerkshelfVersion (string) –

      The Berkshelf version.

  • UseCustomCookbooks (boolean) – Whether to use custom cookbooks.

  • UseOpsworksSecurityGroups (boolean) –

    Whether to associate the OpsWorks Stacks built-in security groups with the stack’s layers.

    OpsWorks Stacks provides a standard set of 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 - OpsWorks Stacks 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 - OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate 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.

  • CustomCookbooksSource (dict) –

    Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

    • Type (string) –

      The repository type.

    • Url (string) –

      The source URL. The following is an example of an Amazon S3 source URL: https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz.

    • Username (string) –

      This parameter depends on the repository type.

      • For Amazon S3 bundles, set Username to the appropriate IAM access key ID.

      • For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name.

    • Password (string) –

      When included in a request, the parameter depends on the repository type.

      • For Amazon S3 bundles, set Password to the appropriate IAM secret access key.

      • For HTTP bundles and Subversion repositories, set Password to the password.

      For more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.

      In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

    • SshKey (string) –

      In requests, the repository’s SSH key.

      In responses, OpsWorks Stacks returns *****FILTERED***** instead of the actual value.

    • Revision (string) –

      The application’s version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.

  • DefaultSshKeyName (string) – A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, 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.

  • ClonePermissions (boolean) – Whether to clone the source stack’s permissions.

  • CloneAppIds (list) –

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

    • (string) –

  • DefaultRootDeviceType (string) – 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.

  • AgentVersion (string) –

    The default OpsWorks Stacks agent version. You have the following options:

    • Auto-update - Set this parameter to LATEST. OpsWorks Stacks 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. OpsWorks Stacks 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. AgentVersion cannot be set to Chef 12.2.

    Note

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

Return type:

dict

Returns:

Response Syntax

{
    'StackId': 'string'
}

Response Structure

  • (dict) –

    Contains the response to a CloneStack request.

    • StackId (string) –

      The cloned stack ID.

Exceptions