Class: Aws::OpsWorks::Types::UpdateStackRequest

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-opsworks/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_version ⇒ 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 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 markdown=“1”> You can also specify an agent version when you create or update an instance, which overrides the stack’s default setting.

</note>

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#attributes ⇒ Hash<String,String>

One or more user-defined key-value pairs to be added to the stack attributes.

Returns:

  • (Hash<String,String>) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#chef_configuration ⇒ Types::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].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html

Returns:



5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_manager ⇒ Types::StackConfigurationManager

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

Returns:



5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#custom_cookbooks_source ⇒ Types::Source

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

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html

Returns:



5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#custom_json ⇒ String

A string that contains user-defined, custom JSON. It can be used to override the corresponding default stack configuration JSON values or to pass data to recipes. The string should be in the following format:

‘“”value1“, ”key2“: ”value2“,…”`

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

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#default_availability_zone ⇒ String

The stack’s default Availability Zone, which must be in the stack’s 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 CreateStack.

[1]: docs.aws.amazon.com/general/latest/gr/rande.html

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#default_instance_profile_arn ⇒ String

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

[1]: docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#default_os ⇒ 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`

  • A supported Windows operating system, such as ‘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 stack’s current 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].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#default_root_device_type ⇒ String

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see [Storage for the Root Device].

[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#default_ssh_key_name ⇒ String

A default Amazon EC2 key-pair name. The default value is ‘none`. If you specify a key-pair name, OpsWorks Stacks 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].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html [3]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#default_subnet_id ⇒ 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.

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#hostname_theme ⇒ String

The stack’s new host name theme, with spaces 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.

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The stack’s new name. Stack names can be a maximum of 64 characters.

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#service_role_arn ⇒ String

Do not use this parameter. You cannot update a stack’s service role.

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The stack ID.

Returns:

  • (String) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#use_custom_cookbooks ⇒ Boolean

Whether the stack uses custom cookbooks.

Returns:

  • (Boolean) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end

#use_opsworks_security_groups ⇒ Boolean

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

OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. ‘UseOpsworksSecurityGroups` allows you to provide your own custom security groups instead of using the built-in 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 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. Custom security groups are required only for those layers that need custom settings.

For more information, see [Create a New Stack].

[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html

Returns:

  • (Boolean) 


5982
5983
5984
5985
5986
5987
5988
5989
5990
5991
5992
5993
5994
5995
5996
5997
5998
5999
6000
6001
6002
6003
 
# File 'lib/aws-sdk-opsworks/types.rb', line 5982

class UpdateStackRequest < Struct.new(
  :stack_id,
  :name,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :default_root_device_type,
  :use_opsworks_security_groups,
  :agent_version)
  SENSITIVE = []
  include Aws::Structure
end