AWS SDK for Go (PILOT)
API Reference

PREVIEW DOCUMENTATION - This is a preview of a new format for the AWS SDK for Go API Reference documentation. For the current AWS SDK for Go API Reference, see https://docs.aws.amazon.com/sdk-for-go/api/.

We welcome your feedback on this new version of the documentation. Send your comments to aws-sdkdocs-feedback@amazon.com.

CloneStackInput

import "github.com/aws/aws-sdk-go/service/opsworks"

type CloneStackInput struct { AgentVersion *string `type:"string"` Attributes map[string]*string `type:"map"` ChefConfiguration *ChefConfiguration `type:"structure"` CloneAppIds []*string `type:"list"` ClonePermissions *bool `type:"boolean"` ConfigurationManager *StackConfigurationManager `type:"structure"` CustomCookbooksSource *Source `type:"structure"` CustomJson *string `type:"string"` DefaultAvailabilityZone *string `type:"string"` DefaultInstanceProfileArn *string `type:"string"` DefaultOs *string `type:"string"` DefaultRootDeviceType *string `type:"string" enum:"RootDeviceType"` DefaultSshKeyName *string `type:"string"` DefaultSubnetId *string `type:"string"` HostnameTheme *string `type:"string"` Name *string `type:"string"` Region *string `type:"string"` ServiceRoleArn *string `type:"string" required:"true"` SourceStackId *string `type:"string" required:"true"` UseCustomCookbooks *bool `type:"boolean"` UseOpsworksSecurityGroups *bool `type:"boolean"` VpcId *string `type:"string"` }

AgentVersion

Type: *string

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

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

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

Attributes

Type: map[string]*string

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

ChefConfiguration

Describes the Chef configuration.

CloneAppIds

Type: []*string

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

ClonePermissions

Type: *bool

Whether to clone the source stack's permissions.

ConfigurationManager

Describes the configuration manager.

CustomCookbooksSource

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps (https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html) or Custom Recipes and Cookbooks (https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html).

CustomJson

Type: *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 (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html)

DefaultAvailabilityZone

Type: *string

The cloned stack's default Availability Zone, which must be in the specified region. For more information, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html). If you also specify a value for DefaultSubnetId, the subnet must be in the same zone. For more information, see the VpcId parameter description.

DefaultInstanceProfileArn

Type: *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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html).

DefaultOs

Type: *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 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 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.

The default option is the parent stack's operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html).

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

Type: *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 (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device).

DefaultSshKeyName

Type: *string

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 (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html) and Managing SSH Access (https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html). You can override this setting by specifying a different key pair, or no key pair, when you create an instance (https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html).

DefaultSubnetId

Type: *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.

HostnameTheme

Type: *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

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

Name

Type: *string

The cloned stack name.

Region

Type: *string

The cloned stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints (https://docs.aws.amazon.com/general/latest/gr/rande.html).

ServiceRoleArn

Type: *string

The stack AWS Identity and Access Management (IAM) role, which allows AWS OpsWorks Stacks 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 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 (https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html).

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.

ServiceRoleArn is a required field

SourceStackId

Type: *string

The source stack ID.

SourceStackId is a required field

UseCustomCookbooks

Type: *bool

Whether to use custom cookbooks.

UseOpsworksSecurityGroups

Type: *bool

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

AWS OpsWorks Stacks 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 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 - AWS OpsWorks Stacks 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 (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html).

VpcId

Type: *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, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS 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 AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC (https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html). For more information about default VPC and EC2 Classic, see Supported Platforms (https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html).

Method

GoString

func (s CloneStackInput) GoString() string

GoString returns the string representation

SetAgentVersion

func (s *CloneStackInput) SetAgentVersion(v string) *CloneStackInput

SetAgentVersion sets the AgentVersion field's value.

SetAttributes

func (s *CloneStackInput) SetAttributes(v map[string]*string) *CloneStackInput

SetAttributes sets the Attributes field's value.

SetChefConfiguration

func (s *CloneStackInput) SetChefConfiguration(v *ChefConfiguration) *CloneStackInput

SetChefConfiguration sets the ChefConfiguration field's value.

SetCloneAppIds

func (s *CloneStackInput) SetCloneAppIds(v []*string) *CloneStackInput

SetCloneAppIds sets the CloneAppIds field's value.

SetClonePermissions

func (s *CloneStackInput) SetClonePermissions(v bool) *CloneStackInput

SetClonePermissions sets the ClonePermissions field's value.

SetConfigurationManager

func (s *CloneStackInput) SetConfigurationManager(v *StackConfigurationManager) *CloneStackInput

SetConfigurationManager sets the ConfigurationManager field's value.

SetCustomCookbooksSource

func (s *CloneStackInput) SetCustomCookbooksSource(v *Source) *CloneStackInput

SetCustomCookbooksSource sets the CustomCookbooksSource field's value.

SetCustomJson

func (s *CloneStackInput) SetCustomJson(v string) *CloneStackInput

SetCustomJson sets the CustomJson field's value.

SetDefaultAvailabilityZone

func (s *CloneStackInput) SetDefaultAvailabilityZone(v string) *CloneStackInput

SetDefaultAvailabilityZone sets the DefaultAvailabilityZone field's value.

SetDefaultInstanceProfileArn

func (s *CloneStackInput) SetDefaultInstanceProfileArn(v string) *CloneStackInput

SetDefaultInstanceProfileArn sets the DefaultInstanceProfileArn field's value.

SetDefaultOs

func (s *CloneStackInput) SetDefaultOs(v string) *CloneStackInput

SetDefaultOs sets the DefaultOs field's value.

SetDefaultRootDeviceType

func (s *CloneStackInput) SetDefaultRootDeviceType(v string) *CloneStackInput

SetDefaultRootDeviceType sets the DefaultRootDeviceType field's value.

SetDefaultSshKeyName

func (s *CloneStackInput) SetDefaultSshKeyName(v string) *CloneStackInput

SetDefaultSshKeyName sets the DefaultSshKeyName field's value.

SetDefaultSubnetId

func (s *CloneStackInput) SetDefaultSubnetId(v string) *CloneStackInput

SetDefaultSubnetId sets the DefaultSubnetId field's value.

SetHostnameTheme

func (s *CloneStackInput) SetHostnameTheme(v string) *CloneStackInput

SetHostnameTheme sets the HostnameTheme field's value.

SetName

func (s *CloneStackInput) SetName(v string) *CloneStackInput

SetName sets the Name field's value.

SetRegion

func (s *CloneStackInput) SetRegion(v string) *CloneStackInput

SetRegion sets the Region field's value.

SetServiceRoleArn

func (s *CloneStackInput) SetServiceRoleArn(v string) *CloneStackInput

SetServiceRoleArn sets the ServiceRoleArn field's value.

SetSourceStackId

func (s *CloneStackInput) SetSourceStackId(v string) *CloneStackInput

SetSourceStackId sets the SourceStackId field's value.

SetUseCustomCookbooks

func (s *CloneStackInput) SetUseCustomCookbooks(v bool) *CloneStackInput

SetUseCustomCookbooks sets the UseCustomCookbooks field's value.

SetUseOpsworksSecurityGroups

func (s *CloneStackInput) SetUseOpsworksSecurityGroups(v bool) *CloneStackInput

SetUseOpsworksSecurityGroups sets the UseOpsworksSecurityGroups field's value.

SetVpcId

func (s *CloneStackInput) SetVpcId(v string) *CloneStackInput

SetVpcId sets the VpcId field's value.

String

func (s CloneStackInput) String() string

String returns the string representation

Validate

func (s *CloneStackInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

On this page: