{
  "InstanceId" : "The instance's AWS OpsWorks Stacks ID.",
  "ValidForInMinutes" : "The length of time (in minutes) that the grant is valid. When the grant expires at the end of this period, the user will no longer be able to use the credentials to log in. If the user is logged in at the time, he or she automatically will be logged out."
}

Returns a list of tags that are applied to the specified stack or layer.

Parameters

$body#

Type: object

{
  "ResourceArn" : "The stack or layer's Amazon Resource Number (ARN).",
  "NextToken" : "Do not use. A validation exception occurs if you add a NextToken parameter to a ListTagsRequest call. ",
  "MaxResults" : "Do not use. A validation exception occurs if you add a MaxResults parameter to a ListTagsRequest call. "
}

reboot_instance#

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "InstanceId" : "The instance ID."
}

register_ecs_cluster#

Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "EcsClusterArn" : "The cluster's ARN.",
  "StackId" : "The stack ID."
}

register_elastic_ip#

Registers an Elastic IP address with a specified stack. An address can be registered with only one stack at a time. If the address is already registered, you must first deregister it by calling DeregisterElasticIp. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "ElasticIp" : "The Elastic IP address.",
  "StackId" : "The stack ID."
}

register_instance#

Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "RsaPublicKey" : "The instances public RSA key. This key is used to encrypt communication between the instance and the service.",
  "PublicIp" : "The instance's public IP address.",
  "PrivateIp" : "The instance's private IP address.",
  "Hostname" : "The instance's hostname.",
  "RsaPublicKeyFingerprint" : "The instances public RSA key fingerprint.",
  "InstanceIdentity" : {
    "Signature" : "A signature that can be used to verify the document's accuracy and authenticity.",
    "Document" : "A JSON document that contains the metadata."
  },
  "StackId" : "The ID of the stack that the instance is to be registered with."
}

register_rds_db_instance#

Registers an Amazon RDS instance with a stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "DbPassword" : "The database password.",
  "RdsDbInstanceArn" : "The Amazon RDS instance's ARN.",
  "StackId" : "The stack ID.",
  "DbUser" : "The database's master user name."
}

register_volume#

Registers an Amazon EBS volume with a specified stack. A volume can be registered with only one stack at a time. If the volume is already registered, you must first deregister it by calling DeregisterVolume. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "Ec2VolumeId" : "The Amazon EBS volume ID.",
  "StackId" : "The stack ID."
}

set_load_based_auto_scaling#

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "DownScaling" : {
    "InstanceCount" : "The number of instances to add or remove when the load exceeds a threshold.",
    "CpuThreshold" : "The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.",
    "ThresholdsWaitTime" : "The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.",
    "MemoryThreshold" : "The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.",
    "Alarms" : [ "string" ],
    "IgnoreMetricsTime" : "The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.",
    "LoadThreshold" : "The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing)."
  },
  "LayerId" : "The layer ID.",
  "UpScaling" : {
    "InstanceCount" : "The number of instances to add or remove when the load exceeds a threshold.",
    "CpuThreshold" : "The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.",
    "ThresholdsWaitTime" : "The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.",
    "MemoryThreshold" : "The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.",
    "Alarms" : [ "string" ],
    "IgnoreMetricsTime" : "The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, AWS OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. IgnoreMetricsTime allows you to direct AWS OpsWorks Stacks to suppress scaling events long enough to get the new instances online.",
    "LoadThreshold" : "The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see Load (computing)."
  },
  "Enable" : "Enables load-based auto scaling for the layer."
}

set_permission#

Specifies a user's permissions. For more information, see Security and Permissions.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "AllowSsh" : "The user is allowed to use SSH to communicate with the instance.",
  "AllowSudo" : "The user is allowed to use sudo to elevate privileges.",
  "Level" : "The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.  \n  deny   \n  show   \n  deploy   \n  manage   \n  iam_only    \nFor more information about the permissions associated with these levels, see Managing User Permissions.",
  "StackId" : "The stack ID.",
  "IamUserArn" : "The user's IAM ARN. This can also be a federated user's ARN."
}

set_time_based_auto_scaling#

Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "AutoScalingSchedule" : {
    "Monday" : "The schedule for Monday.",
    "Thursday" : "The schedule for Thursday.",
    "Friday" : "The schedule for Friday.",
    "Sunday" : "The schedule for Sunday.",
    "Wednesday" : "The schedule for Wednesday.",
    "Tuesday" : "The schedule for Tuesday.",
    "Saturday" : "The schedule for Saturday."
  },
  "InstanceId" : "The instance ID."
}

start_instance#

Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "InstanceId" : "The instance ID."
}

start_stack#

Starts a stack's instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "StackId" : "The stack ID."
}

stop_instance#

Stops a specified instance. When you stop a standard instance, the data disappears and must be reinstalled when you restart the instance. You can stop an Amazon EBS-backed instance without losing data. For more information, see Starting, Stopping, and Rebooting Instances.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "InstanceId" : "The instance ID.",
  "Force" : "Specifies whether to force an instance to stop. If the instance's root device type is ebs, or EBS-backed, adding the Force parameter to the StopInstances API call disassociates the AWS OpsWorks Stacks instance from EC2, and forces deletion of only the OpsWorks Stacks instance. You must also delete the formerly-associated instance in EC2 after troubleshooting and replacing the AWS OpsWorks Stacks instance with a new one."
}

stop_stack#

Stops a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "StackId" : "The stack ID."
}

tag_resource#

Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.

Parameters

$body#

Type: object

{
  "ResourceArn" : "The stack or layer's Amazon Resource Number (ARN).",
  "Tags" : "A map that contains tag keys and tag values that are attached to a stack or layer.  \n The key cannot be empty.  \n The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /   \n The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /   \n Leading and trailing white spaces are trimmed from both the key and value.  \n A maximum of 40 tags is allowed for any resource. "
}

unassign_instance#

Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "InstanceId" : "The instance ID."
}

unassign_volume#

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "VolumeId" : "The volume ID."
}

untag_resource#

Removes tags from a specified stack or layer.

Parameters

$body#

Type: object

{
  "ResourceArn" : "The stack or layer's Amazon Resource Number (ARN).",
  "TagKeys" : [ "string" ]
}

update_app#

Updates a specified app.
Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "Domains" : [ "string" ],
  "DataSources" : [ {
    "Type" : "The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, RdsDbInstance, or None.",
    "DatabaseName" : "The database name.",
    "Arn" : "The data source's ARN."
  } ],
  "Type" : "The app type.",
  "EnableSsl" : "Whether SSL is enabled for the app.",
  "Description" : "A description of the app.",
  "AppId" : "The app ID.",
  "SslConfiguration" : {
    "Chain" : "Optional. Can be used to specify an intermediate certificate authority key or client authentication.",
    "PrivateKey" : "The private key; the contents of the certificate's domain.kex file.",
    "Certificate" : "The contents of the certificate's domain.crt file."
  },
  "Attributes" : "One or more user-defined key/value pairs to be added to the stack attributes.",
  "Environment" : [ {
    "Secure" : "(Optional) Whether the variable's value will be returned by the DescribeApps action. To conceal an environment variable's value, set Secure to true. DescribeApps then returns *****FILTERED***** instead of the actual value. The default value for Secure is false. ",
    "Value" : "(Optional) The environment variable's value, which can be left empty. If you specify a value, it can contain up to 256 characters, which must all be printable.",
    "Key" : "(Required) The environment variable's name, which can consist of up to 64 characters and must be specified. The name can contain upper- and lowercase letters, numbers, and underscores (_), but it must start with a letter or underscore."
  } ],
  "Name" : "The app name.",
  "AppSource" : {
    "SshKey" : "In requests, the repository's SSH key. \nIn responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.",
    "Type" : "The repository type.",
    "Revision" : "The application's version. AWS 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.",
    "Username" : "This parameter depends on the repository type.  \n For Amazon S3 bundles, set Username to the appropriate IAM access key ID.  \n For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name. ",
    "Url" : "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.",
    "Password" : "When included in a request, the parameter depends on the repository type.  \n For Amazon S3 bundles, set Password to the appropriate IAM secret access key.  \n For HTTP bundles and Subversion repositories, set Password to the password.   \nFor more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html. \nIn responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value."
  }
}

update_elastic_ip#

Updates a registered Elastic IP address's name. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "ElasticIp" : "The IP address for which you want to update the name.",
  "Name" : "The new name."
}

update_instance#

Updates a specified instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "SshKeyName" : "The instance's Amazon EC2 key name.",
  "LayerIds" : [ "string" ],
  "Os" : "The instance's operating system, which must be set to one of the following. You cannot update an instance that is using a custom AMI.  \n A supported Linux operating system: An Amazon Linux version, such as 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.  \n A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.  \n  CentOS Linux 7   \n  Red Hat Enterprise Linux 7   \n 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.   \nFor more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems. \nThe default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the AmiId parameter to specify the custom AMI that you want to use. For more information about supported operating systems, see Operating Systems. For more information about how to use custom AMIs with OpsWorks, see Using Custom AMIs.  \nYou can specify a different Linux operating system for the updated stack, but you cannot change from Linux to Windows or Windows to Linux.",
  "Architecture" : "The instance architecture. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.",
  "InstanceId" : "The instance ID.",
  "AgentVersion" : "The default AWS OpsWorks Stacks agent version. You have the following options:  \n  INHERIT - Use the stack's default agent version setting.  \n  version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, you must edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.   \nThe default setting is INHERIT. 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. \nAgentVersion cannot be set to Chef 12.2.",
  "Hostname" : "The instance host name.",
  "InstallUpdatesOnBoot" : "Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.   \nWe strongly recommend using the default value of true, to ensure that your instances have the latest security updates.",
  "AutoScalingType" : "For load-based or time-based instances, the type. Windows stacks can use only time-based instances.",
  "InstanceType" : "The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.",
  "AmiId" : "The ID of the AMI that was used to create the instance. The value of this parameter must be the same AMI ID that the instance is already using. You cannot apply a new AMI to an instance by running UpdateInstance. UpdateInstance does not work on instances that are using custom AMIs. ",
  "EbsOptimized" : "This property cannot be updated."
}

update_layer#

Updates a specified layer.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "EnableAutoHealing" : "Whether to disable auto healing for the layer.",
  "UseEbsOptimizedInstances" : "Whether to use Amazon EBS-optimized instances.",
  "Attributes" : "One or more user-defined key/value pairs to be added to the stack attributes.",
  "CustomInstanceProfileArn" : "The ARN of an IAM profile to be used for all of the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.",
  "InstallUpdatesOnBoot" : "Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.   \nWe strongly recommend using the default value of true, to ensure that your instances have the latest security updates.",
  "VolumeConfigurations" : [ {
    "MountPoint" : "The volume mount point. For example \"/dev/sdh\".",
    "VolumeType" : "The volume type. For more information, see  Amazon EBS Volume Types.  \n  standard - Magnetic. Magnetic volumes must have a minimum size of 1 GiB and a maximum size of 1024 GiB.  \n  io1 - Provisioned IOPS (SSD). PIOPS volumes must have a minimum size of 4 GiB and a maximum size of 16384 GiB.  \n  gp2 - General Purpose (SSD). General purpose volumes must have a minimum size of 1 GiB and a maximum size of 16384 GiB.  \n  st1 - Throughput Optimized hard disk drive (HDD). Throughput optimized HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB.  \n  sc1 - Cold HDD. Cold HDD volumes must have a minimum size of 500 GiB and a maximum size of 16384 GiB. ",
    "RaidLevel" : "The volume RAID level.",
    "Size" : "The volume size.",
    "Encrypted" : "Specifies whether an Amazon EBS volume is encrypted. For more information, see Amazon EBS Encryption.",
    "Iops" : "For PIOPS volumes, the IOPS per disk.",
    "NumberOfDisks" : "The number of disks in the volume."
  } ],
  "Name" : "The layer name, which is used by the console.",
  "CustomSecurityGroupIds" : [ "string" ],
  "LayerId" : "The layer ID.",
  "AutoAssignElasticIps" : "Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.",
  "CloudWatchLogsConfiguration" : {
    "LogStreams" : [ {
      "MultiLineStartPattern" : "Specifies the pattern for identifying the start of a log message.",
      "BatchSize" : "Specifies the maximum size of log events in a batch, in bytes, up to 1048576 bytes. The default value is 32768 bytes. This size is calculated as the sum of all event messages in UTF-8, plus 26 bytes for each log event.",
      "TimeZone" : "Specifies the time zone of log event time stamps.",
      "DatetimeFormat" : "Specifies how the time stamp is extracted from logs. For more information, see the CloudWatch Logs Agent Reference.",
      "InitialPosition" : "Specifies where to start to read data (start_of_file or end_of_file). The default is start_of_file. This setting is only used if there is no state persisted for that log stream.",
      "Encoding" : "Specifies the encoding of the log file so that the file can be read correctly. The default is utf_8. Encodings supported by Python codecs.decode() can be used here.",
      "LogGroupName" : "Specifies the destination log group. A log group is created automatically if it doesn't already exist. Log group names can be between 1 and 512 characters long. Allowed characters include a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), '/' (forward slash), and '.' (period).",
      "FileFingerprintLines" : "Specifies the range of lines for identifying a file. The valid values are one number, or two dash-delimited numbers, such as '1', '2-5'. The default value is '1', meaning the first line is used to calculate the fingerprint. Fingerprint lines are not sent to CloudWatch Logs unless all specified lines are available.",
      "BufferDuration" : "Specifies the time duration for the batching of log events. The minimum value is 5000ms and default value is 5000ms.",
      "File" : "Specifies log files that you want to push to CloudWatch Logs. \n File can point to a specific file or multiple files (by using wild card characters such as /var/log/system.log*). Only the latest file is pushed to CloudWatch Logs, based on file modification time. We recommend that you use wild card characters to specify a series of files of the same type, such as access_log.2014-06-01-01, access_log.2014-06-01-02, and so on by using a pattern like access_log.*. Don't use a wildcard to match multiple file types, such as access_log_80 and access_log_443. To specify multiple, different file types, add another log stream entry to the configuration file, so that each log file type is stored in a different log group. \nZipped files are not supported.",
      "BatchCount" : "Specifies the max number of log events in a batch, up to 10000. The default value is 1000."
    } ],
    "Enabled" : "Whether CloudWatch Logs is enabled for a layer."
  },
  "Packages" : [ "string" ],
  "LifecycleEventConfiguration" : {
    "Shutdown" : {
      "ExecutionTimeout" : "The time, in seconds, that AWS OpsWorks Stacks will wait after triggering a Shutdown event before shutting down an instance.",
      "DelayUntilElbConnectionsDrained" : "Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining "
    }
  },
  "Shortname" : "For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks Stacks and by Chef. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 200 characters and must be in the following format: /\\A[a-z0-9\\-\\_\\.]+\\Z/. \nThe built-in layers' short names are defined by AWS OpsWorks Stacks. For more information, see the Layer Reference ",
  "AutoAssignPublicIps" : "For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see How to Edit a Layer.",
  "CustomRecipes" : {
    "Shutdown" : [ "string" ],
    "Configure" : [ "string" ],
    "Undeploy" : [ "string" ],
    "Deploy" : [ "string" ],
    "Setup" : [ "string" ]
  },
  "CustomJson" : "A JSON-formatted string containing custom stack configuration and deployment attributes to be installed on the layer's instances. For more information, see  Using Custom JSON. "
}

update_my_user_profile#

Updates a user's SSH public key.
Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "SshPublicKey" : "The user's SSH public key."
}

update_rds_db_instance#

Updates an Amazon RDS instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "DbPassword" : "The database password.",
  "RdsDbInstanceArn" : "The Amazon RDS instance's ARN.",
  "DbUser" : "The master user name."
}

update_stack#

Updates a specified stack.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "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.",
  "UseOpsworksSecurityGroups" : "Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers. \nAWS 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:   \n 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.  \n False - AWS 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.   \nFor more information, see Create a New Stack.",
  "ServiceRoleArn" : "Do not use this parameter. You cannot update a stack's service role.",
  "AgentVersion" : "The default AWS OpsWorks Stacks agent version. You have the following options:  \n 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.  \n 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.   \nThe 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.  \nYou can also specify an agent version when you create or update an instance, which overrides the stack's default setting.",
  "UseCustomCookbooks" : "Whether the stack uses custom cookbooks.",
  "Attributes" : "One or more user-defined key-value pairs to be added to the stack attributes.",
  "ChefConfiguration" : {
    "ManageBerkshelf" : "Whether to enable Berkshelf.",
    "BerkshelfVersion" : "The Berkshelf version."
  },
  "DefaultOs" : "The stack's operating system, which must be set to one of the following:  \n A supported Linux operating system: An Amazon Linux version, such as 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.  \n A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.  \n  CentOS Linux 7   \n  Red Hat Enterprise Linux 7   \n 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.  \n 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.   \nThe default option is the stack's current operating system. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems.",
  "DefaultAvailabilityZone" : "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. ",
  "Name" : "The stack's new name.",
  "CustomCookbooksSource" : {
    "SshKey" : "In requests, the repository's SSH key. \nIn responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value.",
    "Type" : "The repository type.",
    "Revision" : "The application's version. AWS 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.",
    "Username" : "This parameter depends on the repository type.  \n For Amazon S3 bundles, set Username to the appropriate IAM access key ID.  \n For HTTP bundles, Git repositories, and Subversion repositories, set Username to the user name. ",
    "Url" : "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.",
    "Password" : "When included in a request, the parameter depends on the repository type.  \n For Amazon S3 bundles, set Password to the appropriate IAM secret access key.  \n For HTTP bundles and Subversion repositories, set Password to the password.   \nFor more information on how to safely handle IAM credentials, see https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html. \nIn responses, AWS OpsWorks Stacks returns *****FILTERED***** instead of the actual value."
  },
  "DefaultRootDeviceType" : "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.",
  "HostnameTheme" : "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:  \n  Baked_Goods   \n  Clouds   \n  Europe_Cities   \n  Fruits   \n  Greek_Deities_and_Titans   \n  Legendary_creatures_from_Japan   \n  Planets_and_Moons   \n  Roman_Deities   \n  Scottish_Islands   \n  US_Cities   \n  Wild_Cats    \nTo obtain a generated host name, call GetHostNameSuggestion, which returns a host name based on the current theme.",
  "DefaultSshKeyName" : "A default Amazon EC2 key-pair name. The default value is none. If you specify a key-pair name, AWS 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. ",
  "DefaultSubnetId" : "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. ",
  "ConfigurationManager" : {
    "Version" : "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 11.4.",
    "Name" : "The name. This parameter must be set to \"Chef\"."
  },
  "StackId" : "The stack ID.",
  "CustomJson" : "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: \n \"{\\\"key1\\\": \\\"value1\\\", \\\"key2\\\": \\\"value2\\\",...}\"  \nFor more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes."
}

update_user_profile#

Updates a specified user profile.
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.

Parameters

$body#

Type: object

{
  "AllowSelfManagement" : "Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.",
  "SshPublicKey" : "The user's new SSH public key.",
  "SshUsername" : "The user's SSH user name. The allowable characters are [a-z], [A-Z], [0-9], '-', and '_'. If the specified name includes other punctuation marks, AWS OpsWorks Stacks removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks Stacks generates one from the IAM user name. ",
  "IamUserArn" : "The user IAM ARN. This can also be a federated user's ARN."
}

update_volume#

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Parameters

$body#

Type: object

{
  "MountPoint" : "The new mount point.",
  "VolumeId" : "The volume ID.",
  "Name" : "The new name."
}