2015/05/07 - AWS OpsWorks - 65 new api methods
Deregisters 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.
Request Syntax
client.deregister_rds_db_instance(
RdsDbInstanceArn='string'
)
string
[REQUIRED]
The Amazon RDS instance's ARN.
None
Creates a layer. For more information, see How to Create a 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.
Request Syntax
client.create_layer(
StackId='string',
Type='java-app'|'lb'|'web'|'php-app'|'rails-app'|'nodejs-app'|'memcached'|'db-master'|'monitoring-master'|'custom',
Name='string',
Shortname='string',
Attributes={
'string': 'string'
},
CustomInstanceProfileArn='string',
CustomSecurityGroupIds=[
'string',
],
Packages=[
'string',
],
VolumeConfigurations=[
{
'MountPoint': 'string',
'RaidLevel': 123,
'NumberOfDisks': 123,
'Size': 123,
'VolumeType': 'string',
'Iops': 123
},
],
EnableAutoHealing=True|False,
AutoAssignElasticIps=True|False,
AutoAssignPublicIps=True|False,
CustomRecipes={
'Setup': [
'string',
],
'Configure': [
'string',
],
'Deploy': [
'string',
],
'Undeploy': [
'string',
],
'Shutdown': [
'string',
]
},
InstallUpdatesOnBoot=True|False,
UseEbsOptimizedInstances=True|False,
LifecycleEventConfiguration={
'Shutdown': {
'ExecutionTimeout': 123,
'DelayUntilElbConnectionsDrained': True|False
}
}
)
string
[REQUIRED]
The layer stack ID.
string
[REQUIRED]
The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers.
string
[REQUIRED]
The layer name, which is used by the console.
string
[REQUIRED]
For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorks and by Chef recipes. 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, which are limited to the alphanumeric characters, '-', '_', and '.'.
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
dict
One or more user-defined key/value pairs to be added to the stack attributes.
(string) --
(string) --
string
The ARN of an IAM profile that to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
list
An array containing the layer custom security group IDs.
(string) --
list
An array of Package objects that describe the layer packages.
(string) --
list
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
(dict) --
Describes an Amazon EBS volume configuration.
MountPoint (string) -- [REQUIRED]
The volume mount point. For example "/dev/sdh".
RaidLevel (integer) --
The volume RAID level.
NumberOfDisks (integer) -- [REQUIRED]
The number of disks in the volume.
Size (integer) -- [REQUIRED]
The volume size.
VolumeType (string) --
The volume type:
standard - Magnetic
io1 - Provisioned IOPS (SSD)
gp2 - General Purpose (SSD)
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
boolean
Whether to disable auto healing for the layer.
boolean
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
boolean
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.
dict
A LayerCustomRecipes object that specifies the layer custom recipes.
Setup (list) --
An array of custom recipe names to be run following a setup event.
(string) --
Configure (list) --
An array of custom recipe names to be run following a configure event.
(string) --
Deploy (list) --
An array of custom recipe names to be run following a deploy event.
(string) --
Undeploy (list) --
An array of custom recipe names to be run following a undeploy event.
(string) --
Shutdown (list) --
An array of custom recipe names to be run following a shutdown event.
(string) --
boolean
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.
boolean
Whether to use Amazon EBS-optimized instances.
dict
A LifeCycleEventConfiguration object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
Shutdown (dict) --
A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
ExecutionTimeout (integer) --
The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.
DelayUntilElbConnectionsDrained (boolean) --
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
dict
Response Syntax
{
'LayerId': 'string'
}
Response Structure
(dict) --
Contains the response to a CreateLayer request.
LayerId (string) --
The layer ID.
Describes Elastic IP addresses.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_elastic_ips(
InstanceId='string',
StackId='string',
Ips=[
'string',
]
)
string
The instance ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses associated with the specified instance.
string
A stack ID. If you include this parameter, DescribeElasticIps returns a description of the Elastic IP addresses that are registered with the specified stack.
list
An array of Elastic IP addresses to be described. If you include this parameter, DescribeElasticIps returns a description of the specified Elastic IP addresses. Otherwise, it returns a description of every Elastic IP address.
(string) --
dict
Response Syntax
{
'ElasticIps': [
{
'Ip': 'string',
'Name': 'string',
'Domain': 'string',
'Region': 'string',
'InstanceId': 'string'
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeElasticIps request.
ElasticIps (list) --
An ElasticIps object that describes the specified Elastic IP addresses.
(dict) --
Describes an Elastic IP address.
Ip (string) --
The IP address.
Name (string) --
The name.
Domain (string) --
The domain.
Region (string) --
The AWS region. For more information, see Regions and Endpoints.
InstanceId (string) --
The ID of the instance that the address is attached to.
Requests a description of a stack's provisioning parameters.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_stack_provisioning_parameters(
StackId='string'
)
string
[REQUIRED]
The stack ID
dict
Response Syntax
{
'AgentInstallerUrl': 'string',
'Parameters': {
'string': 'string'
}
}
Response Structure
(dict) --
Contains the response to a DescribeStackProvisioningParameters request.
AgentInstallerUrl (string) --
The AWS OpsWorks agent installer's URL.
Parameters (dict) --
An embedded object that contains the provisioning parameters.
(string) --
(string) --
Creates an app for a specified stack. For more information, see Creating Apps.
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.
Request Syntax
client.create_app(
StackId='string',
Shortname='string',
Name='string',
Description='string',
DataSources=[
{
'Type': 'string',
'Arn': 'string',
'DatabaseName': 'string'
},
],
Type='java'|'rails'|'php'|'nodejs'|'static'|'other',
AppSource={
'Type': 'git'|'svn'|'archive'|'s3',
'Url': 'string',
'Username': 'string',
'Password': 'string',
'SshKey': 'string',
'Revision': 'string'
},
Domains=[
'string',
],
EnableSsl=True|False,
SslConfiguration={
'Certificate': 'string',
'PrivateKey': 'string',
'Chain': 'string'
},
Attributes={
'string': 'string'
},
Environment=[
{
'Key': 'string',
'Value': 'string',
'Secure': True|False
},
]
)
string
[REQUIRED]
The stack ID.
string
The app's short name.
string
[REQUIRED]
The app name.
string
A description of the app.
list
The app's data source.
(dict) --
Describes an app's data source.
Type (string) --
The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.
Arn (string) --
The data source's ARN.
DatabaseName (string) --
The database name.
string
[REQUIRED]
The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. AWS OpsWorks deploys an application to those instances that are members of the corresponding layer.
dict
A Source object that specifies the app repository.
Type (string) --
The repository type.
Url (string) --
The source URL.
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 http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
SshKey (string) --
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
Revision (string) --
The application's version. AWS OpsWorks 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.
list
The app virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
(string) --
boolean
Whether to enable SSL for the app.
dict
An SslConfiguration object with the SSL configuration.
Certificate (string) -- [REQUIRED]
The contents of the certificate's domain.crt file.
PrivateKey (string) -- [REQUIRED]
The private key; the contents of the certificate's domain.kex file.
Chain (string) --
Optional. Can be used to specify an intermediate certificate authority key or client authentication.
dict
One or more user-defined key/value pairs to be added to the stack attributes.
(string) --
(string) --
list
An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instance. For more information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)."
(dict) --
Represents an app's environment variable.
Key (string) -- [REQUIRED]
(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.
Value (string) -- [REQUIRED]
(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.
Secure (boolean) --
(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.
dict
Response Syntax
{
'AppId': 'string'
}
Response Structure
(dict) --
Contains the response to a CreateApp request.
AppId (string) --
The app ID.
Creates a new user profile.
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.
Request Syntax
client.create_user_profile(
IamUserArn='string',
SshUsername='string',
SshPublicKey='string',
AllowSelfManagement=True|False
)
string
[REQUIRED]
The user's IAM ARN.
string
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 removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.
string
The user's public SSH key.
boolean
Whether users can specify their own SSH public key through the My Settings page. For more information, see Setting an IAM User's Public SSH Key.
dict
Response Syntax
{
'IamUserArn': 'string'
}
Response Structure
(dict) --
Contains the response to a CreateUserProfile request.
IamUserArn (string) --
The user's IAM ARN.
Deletes a specified stack. You must first delete all instances, layers, and apps or deregister registered instances. For more information, see Shut Down 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.
Request Syntax
client.delete_stack(
StackId='string'
)
string
[REQUIRED]
The stack ID.
None
Describe an instance's RAID arrays.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_raid_arrays(
InstanceId='string',
StackId='string',
RaidArrayIds=[
'string',
]
)
string
The instance ID. If you use this parameter, DescribeRaidArrays returns descriptions of the RAID arrays associated with the specified instance.
string
The stack ID.
list
An array of RAID array IDs. If you use this parameter, DescribeRaidArrays returns descriptions of the specified arrays. Otherwise, it returns a description of every array.
(string) --
dict
Response Syntax
{
'RaidArrays': [
{
'RaidArrayId': 'string',
'InstanceId': 'string',
'Name': 'string',
'RaidLevel': 123,
'NumberOfDisks': 123,
'Size': 123,
'Device': 'string',
'MountPoint': 'string',
'AvailabilityZone': 'string',
'CreatedAt': 'string',
'StackId': 'string',
'VolumeType': 'string',
'Iops': 123
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeRaidArrays request.
RaidArrays (list) --
A RaidArrays object that describes the specified RAID arrays.
(dict) --
Describes an instance's RAID array.
RaidArrayId (string) --
The array ID.
InstanceId (string) --
The instance ID.
Name (string) --
The array name.
RaidLevel (integer) --
The RAID level.
NumberOfDisks (integer) --
The number of disks in the array.
Size (integer) --
The array's size.
Device (string) --
The array's Linux device. For example /dev/mdadm0.
MountPoint (string) --
The array's mount point.
AvailabilityZone (string) --
The array's Availability Zone. For more information, see Regions and Endpoints.
CreatedAt (string) --
When the RAID array was created.
StackId (string) --
The stack ID.
VolumeType (string) --
The volume type, standard or PIOPS.
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
Describes time-based auto scaling configurations for specified instances.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_time_based_auto_scaling(
InstanceIds=[
'string',
]
)
list
[REQUIRED]
An array of instance IDs.
(string) --
dict
Response Syntax
{
'TimeBasedAutoScalingConfigurations': [
{
'InstanceId': 'string',
'AutoScalingSchedule': {
'Monday': {
'string': 'string'
},
'Tuesday': {
'string': 'string'
},
'Wednesday': {
'string': 'string'
},
'Thursday': {
'string': 'string'
},
'Friday': {
'string': 'string'
},
'Saturday': {
'string': 'string'
},
'Sunday': {
'string': 'string'
}
}
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeTimeBasedAutoScaling request.
TimeBasedAutoScalingConfigurations (list) --
An array of TimeBasedAutoScalingConfiguration objects that describe the configuration for the specified instances.
(dict) --
Describes an instance's time-based auto scaling configuration.
InstanceId (string) --
The instance ID.
AutoScalingSchedule (dict) --
A WeeklyAutoScalingSchedule object with the instance schedule.
Monday (dict) --
The schedule for Monday.
(string) --
(string) --
Tuesday (dict) --
The schedule for Tuesday.
(string) --
(string) --
Wednesday (dict) --
The schedule for Wednesday.
(string) --
(string) --
Thursday (dict) --
The schedule for Thursday.
(string) --
(string) --
Friday (dict) --
The schedule for Friday.
(string) --
(string) --
Saturday (dict) --
The schedule for Saturday.
(string) --
(string) --
Sunday (dict) --
The schedule for Sunday.
(string) --
(string) --
Creates a new stack. For more information, see Create a New 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.
Request Syntax
client.create_stack(
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',
DefaultRootDeviceType='ebs'|'instance-store'
)
string
[REQUIRED]
The stack name.
string
[REQUIRED]
The stack AWS region, such as "us-east-1". For more information about Amazon regions, see Regions and Endpoints.
string
The ID of the VPC that the 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 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 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.
dict
One or more user-defined key/value pairs to be added to the stack attributes.
(string) --
(string) --
string
[REQUIRED]
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. For more information about IAM ARNs, see Using Identifiers.
string
[REQUIRED]
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.
string
The stack's operating system, which must be set to one of the following.
Standard operating systems: an Amazon Linux version such as Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
Custom AMIs: Custom. You specify the custom AMI you want to use when you create instances.
The default option is the current Amazon Linux version.
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.
string
The 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.
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.
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 and must escape characters such as '"'.:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
dict
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.
Name (string) --
The name. This parameter must be set to "Chef".
Version (string) --
The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.
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.
boolean
Whether the stack uses custom cookbooks.
boolean
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 UseOpsworksSecurityGroups you can instead provide your own custom security groups. 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.
dict
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.
Type (string) --
The repository type.
Url (string) --
The source URL.
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 http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
SshKey (string) --
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
Revision (string) --
The application's version. AWS OpsWorks 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.
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 and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
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. The default option is instance-store. For more information, see Storage for the Root Device.
dict
Response Syntax
{
'StackId': 'string'
}
Response Structure
(dict) --
Contains the response to a CreateStack request.
StackId (string) --
The stack ID, which is an opaque string that you use to identify the stack when performing actions such as DescribeStacks.
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.
Request Syntax
client.unassign_volume(
VolumeId='string'
)
string
[REQUIRED]
The volume ID.
None
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.
Request Syntax
client.reboot_instance(
InstanceId='string'
)
string
[REQUIRED]
The instance ID.
None
Associates one of the stack's registered Elastic IP addresses with a specified instance. The address must first be registered with the stack by calling RegisterElasticIp. 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.
Request Syntax
client.associate_elastic_ip(
ElasticIp='string',
InstanceId='string'
)
string
[REQUIRED]
The Elastic IP address.
string
The instance ID.
None
Specify the load-based auto scaling configuration for a specified layer. 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.
Request Syntax
client.set_load_based_auto_scaling(
LayerId='string',
Enable=True|False,
UpScaling={
'InstanceCount': 123,
'ThresholdsWaitTime': 123,
'IgnoreMetricsTime': 123,
'CpuThreshold': 123.0,
'MemoryThreshold': 123.0,
'LoadThreshold': 123.0
},
DownScaling={
'InstanceCount': 123,
'ThresholdsWaitTime': 123,
'IgnoreMetricsTime': 123,
'CpuThreshold': 123.0,
'MemoryThreshold': 123.0,
'LoadThreshold': 123.0
}
)
string
[REQUIRED]
The layer ID.
boolean
Enables load-based auto scaling for the layer.
dict
An AutoScalingThresholds object with the upscaling threshold configuration. If the load exceeds these thresholds for a specified amount of time, AWS OpsWorks starts a specified number of instances.
InstanceCount (integer) --
The number of instances to add or remove when the load exceeds a threshold.
ThresholdsWaitTime (integer) --
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
IgnoreMetricsTime (integer) --
The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and not raise any additional scaling events. For example, AWS OpsWorks 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 to not raise any scaling events long enough to get the new instances online.
CpuThreshold (float) --
The CPU utilization threshold, as a percent of the available CPU.
MemoryThreshold (float) --
The memory utilization threshold, as a percent of the available memory.
LoadThreshold (float) --
The load threshold. For more information about how load is computed, see Load (computing).
dict
An AutoScalingThresholds object with the downscaling threshold configuration. If the load falls below these thresholds for a specified amount of time, AWS OpsWorks stops a specified number of instances.
InstanceCount (integer) --
The number of instances to add or remove when the load exceeds a threshold.
ThresholdsWaitTime (integer) --
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
IgnoreMetricsTime (integer) --
The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and not raise any additional scaling events. For example, AWS OpsWorks 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 to not raise any scaling events long enough to get the new instances online.
CpuThreshold (float) --
The CPU utilization threshold, as a percent of the available CPU.
MemoryThreshold (float) --
The memory utilization threshold, as a percent of the available memory.
LoadThreshold (float) --
The load threshold. For more information about how load is computed, see Load (computing).
None
Requests a description of a specified set of deployments.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_deployments(
StackId='string',
AppId='string',
DeploymentIds=[
'string',
]
)
string
The stack ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified stack.
string
The app ID. If you include this parameter, DescribeDeployments returns a description of the commands associated with the specified app.
list
An array of deployment IDs to be described. If you include this parameter, DescribeDeployments returns a description of the specified deployments. Otherwise, it returns a description of every deployment.
(string) --
dict
Response Syntax
{
'Deployments': [
{
'DeploymentId': 'string',
'StackId': 'string',
'AppId': 'string',
'CreatedAt': 'string',
'CompletedAt': 'string',
'Duration': 123,
'IamUserArn': 'string',
'Comment': 'string',
'Command': {
'Name': 'install_dependencies'|'update_dependencies'|'update_custom_cookbooks'|'execute_recipes'|'deploy'|'rollback'|'start'|'stop'|'restart'|'undeploy',
'Args': {
'string': [
'string',
]
}
},
'Status': 'string',
'CustomJson': 'string',
'InstanceIds': [
'string',
]
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeDeployments request.
Deployments (list) --
An array of Deployment objects that describe the deployments.
(dict) --
Describes a deployment of a stack or app.
DeploymentId (string) --
The deployment ID.
StackId (string) --
The stack ID.
AppId (string) --
The app ID.
CreatedAt (string) --
Date when the deployment was created.
CompletedAt (string) --
Date when the deployment completed.
Duration (integer) --
The deployment duration.
IamUserArn (string) --
The user's IAM ARN.
Comment (string) --
A user-defined comment.
Command (dict) --
Used to specify a stack or deployment command.
Name (string) --
Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {"recipes":["phpapp::appsetup"]}.
install_dependencies: Install the stack's dependencies.
update_custom_cookbooks: Update the stack's custom cookbooks.
update_dependencies: Update the stack's dependencies.
For apps, the following commands are available:
deploy: Deploy an app. Rails apps have an optional Args parameter named migrate. Set Args to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}.
rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.
start: Start the app's web or application server.
stop: Stop the app's web or application server.
restart: Restart the app's web or application server.
undeploy: Undeploy the app.
Args (dict) --
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}
The update_dependencies command takes two arguments:
upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as Amazon Linux 2014.09. You must also set the allow_reboot argument to true.
allow_reboot - Specifies whether to allow AWS OpsWorks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false.
For example, to upgrade an instance to Amazon Linux 2014.09, set Args to the following.
`` { "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }``
(string) --
(list) --
(string) --
Status (string) --
The deployment status:
running
successful
failed
CustomJson (string) --
A string that contains user-defined custom JSON. It is used to override the corresponding default stack configuration JSON values for stack. The string should be in the following format and must escape characters such as '"'.:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
InstanceIds (list) --
The IDs of the target instances.
(string) --
Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.
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.
Request Syntax
client.create_deployment(
StackId='string',
AppId='string',
InstanceIds=[
'string',
],
Command={
'Name': 'install_dependencies'|'update_dependencies'|'update_custom_cookbooks'|'execute_recipes'|'deploy'|'rollback'|'start'|'stop'|'restart'|'undeploy',
'Args': {
'string': [
'string',
]
}
},
Comment='string',
CustomJson='string'
)
string
[REQUIRED]
The stack ID.
string
The app ID. This parameter is required for app deployments, but not for other deployment commands.
list
The instance IDs for the deployment targets.
(string) --
dict
[REQUIRED]
A DeploymentCommand object that specifies the deployment command and any associated arguments.
Name (string) -- [REQUIRED]
Specifies the operation. You can specify only one command.
For stacks, the following commands are available:
execute_recipes: Execute one or more recipes. To specify the recipes, set an Args parameter named recipes to the list of recipes to be executed. For example, to execute phpapp::appsetup, set Args to {"recipes":["phpapp::appsetup"]}.
install_dependencies: Install the stack's dependencies.
update_custom_cookbooks: Update the stack's custom cookbooks.
update_dependencies: Update the stack's dependencies.
For apps, the following commands are available:
deploy: Deploy an app. Rails apps have an optional Args parameter named migrate. Set Args to {"migrate":["true"]} to migrate the database. The default setting is {"migrate":["false"]}.
rollback Roll the app back to the previous version. When you update an app, AWS OpsWorks stores the previous version, up to a maximum of five versions. You can use this command to roll an app back as many as four versions.
start: Start the app's web or application server.
stop: Stop the app's web or application server.
restart: Restart the app's web or application server.
undeploy: Undeploy the app.
Args (dict) --
The arguments of those commands that take arguments. It should be set to a JSON object with the following format:
{"arg_name1" : ["value1", "value2", ...], "arg_name2" : ["value1", "value2", ...], ...}
The update_dependencies command takes two arguments:
upgrade_os_to - Specifies the desired Amazon Linux version for instances whose OS you want to upgrade, such as Amazon Linux 2014.09. You must also set the allow_reboot argument to true.
allow_reboot - Specifies whether to allow AWS OpsWorks to reboot the instances if necessary, after installing the updates. This argument can be set to either true or false. The default value is false.
For example, to upgrade an instance to Amazon Linux 2014.09, set Args to the following.
`` { "upgrade_os_to":["Amazon Linux 2014.09"], "allow_reboot":["true"] }``
(string) --
(list) --
(string) --
string
A user-defined comment.
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 and must escape characters such as '"'.:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
dict
Response Syntax
{
'DeploymentId': 'string'
}
Response Structure
(dict) --
Contains the response to a CreateDeployment request.
DeploymentId (string) --
The deployment ID, which can be used with other requests to identify the deployment.
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.
Request Syntax
client.update_instance(
InstanceId='string',
LayerIds=[
'string',
],
InstanceType='string',
AutoScalingType='load'|'timer',
Hostname='string',
Os='string',
AmiId='string',
SshKeyName='string',
Architecture='x86_64'|'i386',
InstallUpdatesOnBoot=True|False,
EbsOptimized=True|False
)
string
[REQUIRED]
The instance ID.
list
The instance's layer IDs.
(string) --
string
The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. 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.
string
For load-based or time-based instances, the type.
string
The instance host name.
string
The instance's operating system, which must be set to one of the following.
Standard operating systems: An Amazon Linux version such as Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
Custom AMIs: Custom
The default option is the current Amazon Linux version, such as Amazon Linux 2014.09. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating Systems <http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html>`__For more information on how to use custom AMIs with OpsWorks, see `Using Custom AMIs.
string
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances
string
The instance's Amazon EC2 key name.
string
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.
boolean
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.
boolean
Whether this is an Amazon EBS-optimized instance.
None
Assign a registered instance to a layer.
You can assign registered on-premises instances to any layer type.
You can assign registered Amazon EC2 instances only to custom layers.
You cannot use this action with instances that were created with AWS OpsWorks.
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.
Request Syntax
client.assign_instance(
InstanceId='string',
LayerIds=[
'string',
]
)
string
[REQUIRED]
The instance ID.
list
[REQUIRED]
The layer ID, which must correspond to a custom layer. You cannot assign a registered instance to a built-in layer.
(string) --
None
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.
Request Syntax
client.update_app(
AppId='string',
Name='string',
Description='string',
DataSources=[
{
'Type': 'string',
'Arn': 'string',
'DatabaseName': 'string'
},
],
Type='java'|'rails'|'php'|'nodejs'|'static'|'other',
AppSource={
'Type': 'git'|'svn'|'archive'|'s3',
'Url': 'string',
'Username': 'string',
'Password': 'string',
'SshKey': 'string',
'Revision': 'string'
},
Domains=[
'string',
],
EnableSsl=True|False,
SslConfiguration={
'Certificate': 'string',
'PrivateKey': 'string',
'Chain': 'string'
},
Attributes={
'string': 'string'
},
Environment=[
{
'Key': 'string',
'Value': 'string',
'Secure': True|False
},
]
)
string
[REQUIRED]
The app ID.
string
The app name.
string
A description of the app.
list
The app's data sources.
(dict) --
Describes an app's data source.
Type (string) --
The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.
Arn (string) --
The data source's ARN.
DatabaseName (string) --
The database name.
string
The app type.
dict
A Source object that specifies the app repository.
Type (string) --
The repository type.
Url (string) --
The source URL.
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 http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
SshKey (string) --
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
Revision (string) --
The application's version. AWS OpsWorks 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.
list
The app's virtual host settings, with multiple domains separated by commas. For example: 'www.example.com, example.com'
(string) --
boolean
Whether SSL is enabled for the app.
dict
An SslConfiguration object with the SSL configuration.
Certificate (string) -- [REQUIRED]
The contents of the certificate's domain.crt file.
PrivateKey (string) -- [REQUIRED]
The private key; the contents of the certificate's domain.kex file.
Chain (string) --
Optional. Can be used to specify an intermediate certificate authority key or client authentication.
dict
One or more user-defined key/value pairs to be added to the stack attributes.
(string) --
(string) --
list
An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances.For more information, see Environment Variables.
There is no specific limit on the number of environment variables. However, the size of the associated data structure - which includes the variables' names, values, and protected flag values - cannot exceed 10 KB (10240 Bytes). This limit should accommodate most if not all use cases. Exceeding it will cause an exception with the message, "Environment: is too large (maximum is 10KB)."
(dict) --
Represents an app's environment variable.
Key (string) -- [REQUIRED]
(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.
Value (string) -- [REQUIRED]
(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.
Secure (boolean) --
(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.
None
Requests a description of a specified set of apps.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_apps(
StackId='string',
AppIds=[
'string',
]
)
string
The app stack ID. If you use this parameter, DescribeApps returns a description of the apps in the specified stack.
list
An array of app IDs for the apps to be described. If you use this parameter, DescribeApps returns a description of the specified apps. Otherwise, it returns a description of every app.
(string) --
dict
Response Syntax
{
'Apps': [
{
'AppId': 'string',
'StackId': 'string',
'Shortname': 'string',
'Name': 'string',
'Description': 'string',
'DataSources': [
{
'Type': 'string',
'Arn': 'string',
'DatabaseName': 'string'
},
],
'Type': 'java'|'rails'|'php'|'nodejs'|'static'|'other',
'AppSource': {
'Type': 'git'|'svn'|'archive'|'s3',
'Url': 'string',
'Username': 'string',
'Password': 'string',
'SshKey': 'string',
'Revision': 'string'
},
'Domains': [
'string',
],
'EnableSsl': True|False,
'SslConfiguration': {
'Certificate': 'string',
'PrivateKey': 'string',
'Chain': 'string'
},
'Attributes': {
'string': 'string'
},
'CreatedAt': 'string',
'Environment': [
{
'Key': 'string',
'Value': 'string',
'Secure': True|False
},
]
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeApps request.
Apps (list) --
An array of App objects that describe the specified apps.
(dict) --
A description of the app.
AppId (string) --
The app ID.
StackId (string) --
The app stack ID.
Shortname (string) --
The app's short name.
Name (string) --
The app name.
Description (string) --
A description of the app.
DataSources (list) --
The app's data sources.
(dict) --
Describes an app's data source.
Type (string) --
The data source's type, AutoSelectOpsworksMysqlInstance, OpsworksMysqlInstance, or RdsDbInstance.
Arn (string) --
The data source's ARN.
DatabaseName (string) --
The database name.
Type (string) --
The app type.
AppSource (dict) --
A Source object that describes the app repository.
Type (string) --
The repository type.
Url (string) --
The source URL.
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 http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
SshKey (string) --
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
Revision (string) --
The application's version. AWS OpsWorks 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.
Domains (list) --
The app vhost settings with multiple domains separated by commas. For example: 'www.example.com, example.com'
(string) --
EnableSsl (boolean) --
Whether to enable SSL for the app.
SslConfiguration (dict) --
An SslConfiguration object with the SSL configuration.
Certificate (string) --
The contents of the certificate's domain.crt file.
PrivateKey (string) --
The private key; the contents of the certificate's domain.kex file.
Chain (string) --
Optional. Can be used to specify an intermediate certificate authority key or client authentication.
Attributes (dict) --
The stack attributes.
(string) --
(string) --
CreatedAt (string) --
When the app was created.
Environment (list) --
An array of EnvironmentVariable objects that specify environment variables to be associated with the app. After you deploy the app, these variables are defined on the associated app server instances. For more information, see Environment Variables.
(dict) --
Represents an app's environment variable.
Key (string) --
(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.
Value (string) --
(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.
Secure (boolean) --
(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.
Deregisters a specified Elastic IP address. The address can then be registered by another 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.
Request Syntax
client.deregister_elastic_ip(
ElasticIp='string'
)
string
[REQUIRED]
The Elastic IP address.
None
Describes AWS OpsWorks service errors.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_service_errors(
StackId='string',
InstanceId='string',
ServiceErrorIds=[
'string',
]
)
string
The stack ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified stack.
string
The instance ID. If you use this parameter, DescribeServiceErrors returns descriptions of the errors associated with the specified instance.
list
An array of service error IDs. If you use this parameter, DescribeServiceErrors returns descriptions of the specified errors. Otherwise, it returns a description of every error.
(string) --
dict
Response Syntax
{
'ServiceErrors': [
{
'ServiceErrorId': 'string',
'StackId': 'string',
'InstanceId': 'string',
'Type': 'string',
'Message': 'string',
'CreatedAt': 'string'
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeServiceErrors request.
ServiceErrors (list) --
An array of ServiceError objects that describe the specified service errors.
(dict) --
Describes an AWS OpsWorks service error.
ServiceErrorId (string) --
The error ID.
StackId (string) --
The stack ID.
InstanceId (string) --
The instance ID.
Type (string) --
The error type.
Message (string) --
A message that describes the error.
CreatedAt (string) --
When the error occurred.
Registers instances with a specified stack that were created outside of AWS OpsWorks.
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.
Request Syntax
client.register_instance(
StackId='string',
Hostname='string',
PublicIp='string',
PrivateIp='string',
RsaPublicKey='string',
RsaPublicKeyFingerprint='string',
InstanceIdentity={
'Document': 'string',
'Signature': 'string'
}
)
string
[REQUIRED]
The ID of the stack that the instance is to be registered with.
string
The instance's hostname.
string
The instance's public IP address.
string
The instance's private IP address.
string
The instances public RSA key. This key is used to encrypt communication between the instance and the service.
string
The instances public RSA key fingerprint.
dict
An InstanceIdentity object that contains the instance's identity.
Document (string) --
A JSON document that contains the metadata.
Signature (string) --
A signature that can be used to verify the document's accuracy and authenticity.
dict
Response Syntax
{
'InstanceId': 'string'
}
Response Structure
(dict) --
Contains the response to a RegisterInstanceResult request.
InstanceId (string) --
The registered instance's AWS OpsWorks ID.
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.
Request Syntax
client.update_rds_db_instance(
RdsDbInstanceArn='string',
DbUser='string',
DbPassword='string'
)
string
[REQUIRED]
The Amazon RDS instance's ARN.
string
The master user name.
string
The database password.
None
Deletes a specified layer. You must first stop and then delete all associated instances or unassign registered instances. For more information, see How to Delete a 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.
Request Syntax
client.delete_layer(
LayerId='string'
)
string
[REQUIRED]
The layer ID.
None
Describes the results of specified commands.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_commands(
DeploymentId='string',
InstanceId='string',
CommandIds=[
'string',
]
)
string
The deployment ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified deployment.
string
The instance ID. If you include this parameter, DescribeCommands returns a description of the commands associated with the specified instance.
list
An array of command IDs. If you include this parameter, DescribeCommands returns a description of the specified commands. Otherwise, it returns a description of every command.
(string) --
dict
Response Syntax
{
'Commands': [
{
'CommandId': 'string',
'InstanceId': 'string',
'DeploymentId': 'string',
'CreatedAt': 'string',
'AcknowledgedAt': 'string',
'CompletedAt': 'string',
'Status': 'string',
'ExitCode': 123,
'LogUrl': 'string',
'Type': 'string'
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeCommands request.
Commands (list) --
An array of Command objects that describe each of the specified commands.
(dict) --
Describes a command.
CommandId (string) --
The command ID.
InstanceId (string) --
The ID of the instance where the command was executed.
DeploymentId (string) --
The command deployment ID.
CreatedAt (string) --
Date and time when the command was run.
AcknowledgedAt (string) --
Date and time when the command was acknowledged.
CompletedAt (string) --
Date when the command completed.
Status (string) --
The command status:
failed
successful
skipped
pending
ExitCode (integer) --
The command exit code.
LogUrl (string) --
The URL of the command log.
Type (string) --
The command type:
deploy
rollback
start
stop
restart
undeploy
update_dependencies
install_dependencies
update_custom_cookbooks
execute_recipes
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.
Request Syntax
client.set_time_based_auto_scaling(
InstanceId='string',
AutoScalingSchedule={
'Monday': {
'string': 'string'
},
'Tuesday': {
'string': 'string'
},
'Wednesday': {
'string': 'string'
},
'Thursday': {
'string': 'string'
},
'Friday': {
'string': 'string'
},
'Saturday': {
'string': 'string'
},
'Sunday': {
'string': 'string'
}
}
)
string
[REQUIRED]
The instance ID.
dict
An AutoScalingSchedule with the instance schedule.
Monday (dict) --
The schedule for Monday.
(string) --
(string) --
Tuesday (dict) --
The schedule for Tuesday.
(string) --
(string) --
Wednesday (dict) --
The schedule for Wednesday.
(string) --
(string) --
Thursday (dict) --
The schedule for Thursday.
(string) --
(string) --
Friday (dict) --
The schedule for Friday.
(string) --
(string) --
Saturday (dict) --
The schedule for Saturday.
(string) --
(string) --
Sunday (dict) --
The schedule for Sunday.
(string) --
(string) --
None
Gets a generated host name for the specified layer, based on the current host name theme.
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.
Request Syntax
client.get_hostname_suggestion(
LayerId='string'
)
string
[REQUIRED]
The layer ID.
dict
Response Syntax
{
'LayerId': 'string',
'Hostname': 'string'
}
Response Structure
(dict) --
Contains the response to a GetHostnameSuggestion request.
LayerId (string) --
The layer ID.
Hostname (string) --
The generated host name.
Describes the permissions for 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.
Request Syntax
client.describe_permissions(
IamUserArn='string',
StackId='string'
)
string
The user's IAM ARN. For more information about IAM ARNs, see Using Identifiers.
string
The stack ID.
dict
Response Syntax
{
'Permissions': [
{
'StackId': 'string',
'IamUserArn': 'string',
'AllowSsh': True|False,
'AllowSudo': True|False,
'Level': 'string'
},
]
}
Response Structure
(dict) --
Contains the response to a DescribePermissions request.
Permissions (list) --
An array of Permission objects that describe the stack permissions.
If the request object contains only a stack ID, the array contains a Permission object with permissions for each of the stack IAM ARNs.
If the request object contains only an IAM ARN, the array contains a Permission object with permissions for each of the user's stack IDs.
If the request contains a stack ID and an IAM ARN, the array contains a single Permission object with permissions for the specified stack and IAM ARN.
(dict) --
Describes stack or user permissions.
StackId (string) --
A stack ID.
IamUserArn (string) --
The Amazon Resource Name (ARN) for an AWS Identity and Access Management (IAM) role. For more information about IAM ARNs, see Using Identifiers.
AllowSsh (boolean) --
Whether the user can use SSH.
AllowSudo (boolean) --
Whether the user can use sudo.
Level (string) --
The user's permission level, which must be the following:
deny
show
deploy
manage
iam_only
For more information on the permissions associated with these levels, see Managing User Permissions
Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.
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.
Request Syntax
client.attach_elastic_load_balancer(
ElasticLoadBalancerName='string',
LayerId='string'
)
string
[REQUIRED]
The Elastic Load Balancing instance's name.
string
[REQUIRED]
The ID of the layer that the Elastic Load Balancing instance is to be attached to.
None
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.
Request Syntax
client.start_instance(
InstanceId='string'
)
string
[REQUIRED]
The instance ID.
None
Describes an instance's Amazon EBS volumes.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_volumes(
InstanceId='string',
StackId='string',
RaidArrayId='string',
VolumeIds=[
'string',
]
)
string
The instance ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified instance.
string
A stack ID. The action describes the stack's registered Amazon EBS volumes.
string
The RAID array ID. If you use this parameter, DescribeVolumes returns descriptions of the volumes associated with the specified RAID array.
list
Am array of volume IDs. If you use this parameter, DescribeVolumes returns descriptions of the specified volumes. Otherwise, it returns a description of every volume.
(string) --
dict
Response Syntax
{
'Volumes': [
{
'VolumeId': 'string',
'Ec2VolumeId': 'string',
'Name': 'string',
'RaidArrayId': 'string',
'InstanceId': 'string',
'Status': 'string',
'Size': 123,
'Device': 'string',
'MountPoint': 'string',
'Region': 'string',
'AvailabilityZone': 'string',
'VolumeType': 'string',
'Iops': 123
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeVolumes request.
Volumes (list) --
An array of volume IDs.
(dict) --
Describes an instance's Amazon EBS volume.
VolumeId (string) --
The volume ID.
Ec2VolumeId (string) --
The Amazon EC2 volume ID.
Name (string) --
The volume name.
RaidArrayId (string) --
The RAID array ID.
InstanceId (string) --
The instance ID.
Status (string) --
The value returned by DescribeVolumes.
Size (integer) --
The volume size.
Device (string) --
The device name.
MountPoint (string) --
The volume mount point. For example "/dev/sdh".
Region (string) --
The AWS region. For more information about AWS regions, see Regions and Endpoints.
AvailabilityZone (string) --
The volume Availability Zone. For more information, see Regions and Endpoints.
VolumeType (string) --
The volume type, standard or PIOPS.
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
Creates an instance in a specified stack. For more information, see Adding an Instance to a 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.
Request Syntax
client.create_instance(
StackId='string',
LayerIds=[
'string',
],
InstanceType='string',
AutoScalingType='load'|'timer',
Hostname='string',
Os='string',
AmiId='string',
SshKeyName='string',
AvailabilityZone='string',
VirtualizationType='string',
SubnetId='string',
Architecture='x86_64'|'i386',
RootDeviceType='ebs'|'instance-store',
BlockDeviceMappings=[
{
'DeviceName': 'string',
'NoDevice': 'string',
'VirtualName': 'string',
'Ebs': {
'SnapshotId': 'string',
'Iops': 123,
'VolumeSize': 123,
'VolumeType': 'gp2'|'io1'|'standard',
'DeleteOnTermination': True|False
}
},
],
InstallUpdatesOnBoot=True|False,
EbsOptimized=True|False
)
string
[REQUIRED]
The stack ID.
list
[REQUIRED]
An array that contains the instance layer IDs.
(string) --
string
[REQUIRED]
The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. 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.
string
For load-based or time-based instances, the type.
string
The instance host name.
string
The instance's operating system, which must be set to one of the following.
Standard operating systems: an Amazon Linux version such as Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
Custom AMIs: Custom
The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. For more information on the standard operating systems, see Operating Systems <http://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html>`__For more information on how to use custom AMIs with OpsWorks, see `Using Custom AMIs.
string
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks AMIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances.
string
The instance's Amazon EC2 key pair name.
string
The instance Availability Zone. For more information, see Regions and Endpoints.
string
The instance's virtualization type, paravirtual or hvm.
string
The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks to launch the instance in a different subnet.
string
The instance architecture. The default option is x86_64. 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.
string
The instance root device type. For more information, see Storage for the Root Device.
list
An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping.
(dict) --
Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.
DeviceName (string) --
The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks will provide the correct device name.
NoDevice (string) --
Suppresses the specified device included in the AMI's block device mapping.
VirtualName (string) --
The virtual device name. For more information, see BlockDeviceMapping.
Ebs (dict) --
An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.
SnapshotId (string) --
The snapshot ID.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
VolumeSize (integer) --
The volume size, in GiB. For more information, see EbsBlockDevice.
VolumeType (string) --
The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.
DeleteOnTermination (boolean) --
Whether the volume is deleted on instance termination.
boolean
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.
boolean
Whether to create an Amazon EBS-optimized instance.
dict
Response Syntax
{
'InstanceId': 'string'
}
Response Structure
(dict) --
Contains the response to a CreateInstance request.
InstanceId (string) --
The instance ID.
Deregister a registered Amazon EC2 or on-premises instance. This action removes the instance from the stack and returns it to your control. This action can not be used with instances that were created with AWS OpsWorks.
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.
Request Syntax
client.deregister_instance(
InstanceId='string'
)
string
[REQUIRED]
The instance ID.
None
Deletes a user profile.
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.
Request Syntax
client.delete_user_profile(
IamUserArn='string'
)
string
[REQUIRED]
The user's IAM ARN.
None
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.
Request Syntax
client.start_stack(
StackId='string'
)
string
[REQUIRED]
The stack ID.
None
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 on user permissions, see Managing User Permissions.
Request Syntax
client.update_user_profile(
IamUserArn='string',
SshUsername='string',
SshPublicKey='string',
AllowSelfManagement=True|False
)
string
[REQUIRED]
The user IAM ARN.
string
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 removes them. For example, my.name will be changed to myname. If you do not specify an SSH user name, AWS OpsWorks generates one from the IAM user name.
string
The user's new SSH public key.
boolean
Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
None
Describes load-based auto scaling configurations for specified layers.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_load_based_auto_scaling(
LayerIds=[
'string',
]
)
list
[REQUIRED]
An array of layer IDs.
(string) --
dict
Response Syntax
{
'LoadBasedAutoScalingConfigurations': [
{
'LayerId': 'string',
'Enable': True|False,
'UpScaling': {
'InstanceCount': 123,
'ThresholdsWaitTime': 123,
'IgnoreMetricsTime': 123,
'CpuThreshold': 123.0,
'MemoryThreshold': 123.0,
'LoadThreshold': 123.0
},
'DownScaling': {
'InstanceCount': 123,
'ThresholdsWaitTime': 123,
'IgnoreMetricsTime': 123,
'CpuThreshold': 123.0,
'MemoryThreshold': 123.0,
'LoadThreshold': 123.0
}
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeLoadBasedAutoScaling request.
LoadBasedAutoScalingConfigurations (list) --
An array of LoadBasedAutoScalingConfiguration objects that describe each layer's configuration.
(dict) --
Describes a layer's load-based auto scaling configuration.
LayerId (string) --
The layer ID.
Enable (boolean) --
Whether load-based auto scaling is enabled for the layer.
UpScaling (dict) --
An AutoScalingThresholds object that describes the upscaling configuration, which defines how and when AWS OpsWorks increases the number of instances.
InstanceCount (integer) --
The number of instances to add or remove when the load exceeds a threshold.
ThresholdsWaitTime (integer) --
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
IgnoreMetricsTime (integer) --
The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and not raise any additional scaling events. For example, AWS OpsWorks 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 to not raise any scaling events long enough to get the new instances online.
CpuThreshold (float) --
The CPU utilization threshold, as a percent of the available CPU.
MemoryThreshold (float) --
The memory utilization threshold, as a percent of the available memory.
LoadThreshold (float) --
The load threshold. For more information about how load is computed, see Load (computing).
DownScaling (dict) --
An AutoScalingThresholds object that describes the downscaling configuration, which defines how and when AWS OpsWorks reduces the number of instances.
InstanceCount (integer) --
The number of instances to add or remove when the load exceeds a threshold.
ThresholdsWaitTime (integer) --
The amount of time, in minutes, that the load must exceed a threshold before more instances are added or removed.
IgnoreMetricsTime (integer) --
The amount of time (in minutes) after a scaling event occurs that AWS OpsWorks should ignore metrics and not raise any additional scaling events. For example, AWS OpsWorks 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 to not raise any scaling events long enough to get the new instances online.
CpuThreshold (float) --
The CPU utilization threshold, as a percent of the available CPU.
MemoryThreshold (float) --
The memory utilization threshold, as a percent of the available memory.
LoadThreshold (float) --
The load threshold. For more information about how load is computed, see Load (computing).
Deletes a specified app.
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.
Request Syntax
client.delete_app(
AppId='string'
)
string
[REQUIRED]
The app ID.
None
Assigns one of the stack's registered Amazon EBS volumes to a specified instance. The volume must first be registered with the stack by calling RegisterVolume. After you register the volume, you must call UpdateVolume to specify a mount point before calling AssignVolume. 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.
Request Syntax
client.assign_volume(
VolumeId='string',
InstanceId='string'
)
string
[REQUIRED]
The volume ID.
string
The instance ID.
None
Requests a description of one or more layers in a specified stack.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_layers(
StackId='string',
LayerIds=[
'string',
]
)
string
The stack ID.
list
An array of layer IDs that specify the layers to be described. If you omit this parameter, DescribeLayers returns a description of every layer in the specified stack.
(string) --
dict
Response Syntax
{
'Layers': [
{
'StackId': 'string',
'LayerId': 'string',
'Type': 'java-app'|'lb'|'web'|'php-app'|'rails-app'|'nodejs-app'|'memcached'|'db-master'|'monitoring-master'|'custom',
'Name': 'string',
'Shortname': 'string',
'Attributes': {
'string': 'string'
},
'CustomInstanceProfileArn': 'string',
'CustomSecurityGroupIds': [
'string',
],
'DefaultSecurityGroupNames': [
'string',
],
'Packages': [
'string',
],
'VolumeConfigurations': [
{
'MountPoint': 'string',
'RaidLevel': 123,
'NumberOfDisks': 123,
'Size': 123,
'VolumeType': 'string',
'Iops': 123
},
],
'EnableAutoHealing': True|False,
'AutoAssignElasticIps': True|False,
'AutoAssignPublicIps': True|False,
'DefaultRecipes': {
'Setup': [
'string',
],
'Configure': [
'string',
],
'Deploy': [
'string',
],
'Undeploy': [
'string',
],
'Shutdown': [
'string',
]
},
'CustomRecipes': {
'Setup': [
'string',
],
'Configure': [
'string',
],
'Deploy': [
'string',
],
'Undeploy': [
'string',
],
'Shutdown': [
'string',
]
},
'CreatedAt': 'string',
'InstallUpdatesOnBoot': True|False,
'UseEbsOptimizedInstances': True|False,
'LifecycleEventConfiguration': {
'Shutdown': {
'ExecutionTimeout': 123,
'DelayUntilElbConnectionsDrained': True|False
}
}
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeLayers request.
Layers (list) --
An array of Layer objects that describe the layers.
(dict) --
Describes a layer.
StackId (string) --
The layer stack ID.
LayerId (string) --
The layer ID.
Type (string) --
The layer type.
Name (string) --
The layer name.
Shortname (string) --
The layer short name.
Attributes (dict) --
The layer attributes.
(string) --
(string) --
CustomInstanceProfileArn (string) --
The ARN of the default IAM profile to be used for the layer's EC2 instances. For more information about IAM ARNs, see Using Identifiers.
CustomSecurityGroupIds (list) --
An array containing the layer's custom security group IDs.
(string) --
DefaultSecurityGroupNames (list) --
An array containing the layer's security group names.
(string) --
Packages (list) --
An array of Package objects that describe the layer's packages.
(string) --
VolumeConfigurations (list) --
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
(dict) --
Describes an Amazon EBS volume configuration.
MountPoint (string) --
The volume mount point. For example "/dev/sdh".
RaidLevel (integer) --
The volume RAID level.
NumberOfDisks (integer) --
The number of disks in the volume.
Size (integer) --
The volume size.
VolumeType (string) --
The volume type:
standard - Magnetic
io1 - Provisioned IOPS (SSD)
gp2 - General Purpose (SSD)
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
EnableAutoHealing (boolean) --
Whether auto healing is disabled for the layer.
AutoAssignElasticIps (boolean) --
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
AutoAssignPublicIps (boolean) --
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.
DefaultRecipes (dict) --
AWS OpsWorks supports five lifecycle events, setup, configuration, deploy, undeploy, and shutdown. For each layer, AWS OpsWorks runs a set of standard recipes for each event. In addition, you can provide custom recipes for any or all layers and events. AWS OpsWorks runs custom event recipes after the standard recipes. LayerCustomRecipes specifies the custom recipes for a particular layer to be run in response to each of the five events.
To specify a recipe, use the cookbook's directory name in the repository followed by two colons and the recipe name, which is the recipe's file name without the .rb extension. For example: phpapp2::dbsetup specifies the dbsetup.rb recipe in the repository's phpapp2 folder.
Setup (list) --
An array of custom recipe names to be run following a setup event.
(string) --
Configure (list) --
An array of custom recipe names to be run following a configure event.
(string) --
Deploy (list) --
An array of custom recipe names to be run following a deploy event.
(string) --
Undeploy (list) --
An array of custom recipe names to be run following a undeploy event.
(string) --
Shutdown (list) --
An array of custom recipe names to be run following a shutdown event.
(string) --
CustomRecipes (dict) --
A LayerCustomRecipes object that specifies the layer's custom recipes.
Setup (list) --
An array of custom recipe names to be run following a setup event.
(string) --
Configure (list) --
An array of custom recipe names to be run following a configure event.
(string) --
Deploy (list) --
An array of custom recipe names to be run following a deploy event.
(string) --
Undeploy (list) --
An array of custom recipe names to be run following a undeploy event.
(string) --
Shutdown (list) --
An array of custom recipe names to be run following a shutdown event.
(string) --
CreatedAt (string) --
Date when the layer was created.
InstallUpdatesOnBoot (boolean) --
Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set 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.
UseEbsOptimizedInstances (boolean) --
Whether the layer uses Amazon EBS-optimized instances.
LifecycleEventConfiguration (dict) --
A LifeCycleEventConfiguration object that specifies the Shutdown event configuration.
Shutdown (dict) --
A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
ExecutionTimeout (integer) --
The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.
DelayUntilElbConnectionsDrained (boolean) --
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
Detaches a specified Elastic Load Balancing instance from its 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.
Request Syntax
client.detach_elastic_load_balancer(
ElasticLoadBalancerName='string',
LayerId='string'
)
string
[REQUIRED]
The Elastic Load Balancing instance's name.
string
[REQUIRED]
The ID of the layer that the Elastic Load Balancing instance is attached to.
None
Describe specified users.
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.
Request Syntax
client.describe_user_profiles(
IamUserArns=[
'string',
]
)
list
An array of IAM user ARNs that identify the users to be described.
(string) --
dict
Response Syntax
{
'UserProfiles': [
{
'IamUserArn': 'string',
'Name': 'string',
'SshUsername': 'string',
'SshPublicKey': 'string',
'AllowSelfManagement': True|False
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeUserProfiles request.
UserProfiles (list) --
A Users object that describes the specified users.
(dict) --
Describes a user's SSH information.
IamUserArn (string) --
The user's IAM ARN.
Name (string) --
The user's name.
SshUsername (string) --
The user's SSH user name.
SshPublicKey (string) --
The user's SSH public key.
AllowSelfManagement (boolean) --
Whether users can specify their own SSH public key through the My Settings page. For more information, see Managing User Permissions.
Requests a description of one or more stacks.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_stacks(
StackIds=[
'string',
]
)
list
An array of stack IDs that specify the stacks to be described. If you omit this parameter, DescribeStacks returns a description of every stack.
(string) --
dict
Response Syntax
{
'Stacks': [
{
'StackId': 'string',
'Name': 'string',
'Arn': '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',
'CreatedAt': 'string',
'DefaultRootDeviceType': 'ebs'|'instance-store'
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeStacks request.
Stacks (list) --
An array of Stack objects that describe the stacks.
(dict) --
Describes a stack.
StackId (string) --
The stack ID.
Name (string) --
The stack name.
Arn (string) --
The stack's ARN.
Region (string) --
The stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
VpcId (string) --
The VPC ID, if the stack is running in a VPC.
Attributes (dict) --
The stack's attributes.
(string) --
(string) --
ServiceRoleArn (string) --
The stack AWS Identity and Access Management (IAM) role.
DefaultInstanceProfileArn (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.
DefaultOs (string) --
The stack's default operating system.
HostnameTheme (string) --
The stack host name theme, with spaces replaced by underscores.
DefaultAvailabilityZone (string) --
The stack's default Availability Zone. For more information, see Regions and Endpoints.
DefaultSubnetId (string) --
The default subnet ID, if the stack is running in a VPC.
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 and must escape characters such as '"'.:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
ConfigurationManager (dict) --
The configuration manager.
Name (string) --
The name. This parameter must be set to "Chef".
Version (string) --
The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.
ChefConfiguration (dict) --
A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.
ManageBerkshelf (boolean) --
Whether to enable Berkshelf.
BerkshelfVersion (string) --
The Berkshelf version.
UseCustomCookbooks (boolean) --
Whether the stack uses custom cookbooks.
UseOpsworksSecurityGroups (boolean) --
Whether the stack automatically associates the AWS OpsWorks built-in security groups with the stack's layers.
CustomCookbooksSource (dict) --
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.
Type (string) --
The repository type.
Url (string) --
The source URL.
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 http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
SshKey (string) --
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
Revision (string) --
The application's version. AWS OpsWorks 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 for the stack's instances. You can override this value when you create or update an instance.
CreatedAt (string) --
Date when the stack was created.
DefaultRootDeviceType (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.
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_stack_summary(
StackId='string'
)
string
[REQUIRED]
The stack ID.
dict
Response Syntax
{
'StackSummary': {
'StackId': 'string',
'Name': 'string',
'Arn': 'string',
'LayersCount': 123,
'AppsCount': 123,
'InstancesCount': {
'Assigning': 123,
'Booting': 123,
'ConnectionLost': 123,
'Deregistering': 123,
'Online': 123,
'Pending': 123,
'Rebooting': 123,
'Registered': 123,
'Registering': 123,
'Requested': 123,
'RunningSetup': 123,
'SetupFailed': 123,
'ShuttingDown': 123,
'StartFailed': 123,
'Stopped': 123,
'Stopping': 123,
'Terminated': 123,
'Terminating': 123,
'Unassigning': 123
}
}
}
Response Structure
(dict) --
Contains the response to a DescribeStackSummary request.
StackSummary (dict) --
A StackSummary object that contains the results.
StackId (string) --
The stack ID.
Name (string) --
The stack name.
Arn (string) --
The stack's ARN.
LayersCount (integer) --
The number of layers.
AppsCount (integer) --
The number of apps.
InstancesCount (dict) --
An InstancesCount object with the number of instances in each status.
Assigning (integer) --
The number of instances in the Assigning state.
Booting (integer) --
The number of instances with booting status.
ConnectionLost (integer) --
The number of instances with connection_lost status.
Deregistering (integer) --
The number of instances in the Deregistering state.
Online (integer) --
The number of instances with online status.
Pending (integer) --
The number of instances with pending status.
Rebooting (integer) --
The number of instances with rebooting status.
Registered (integer) --
The number of instances in the Registered state.
Registering (integer) --
The number of instances in the Registering state.
Requested (integer) --
The number of instances with requested status.
RunningSetup (integer) --
The number of instances with running_setup status.
SetupFailed (integer) --
The number of instances with setup_failed status.
ShuttingDown (integer) --
The number of instances with shutting_down status.
StartFailed (integer) --
The number of instances with start_failed status.
Stopped (integer) --
The number of instances with stopped status.
Stopping (integer) --
The number of instances with stopping status.
Terminated (integer) --
The number of instances with terminated status.
Terminating (integer) --
The number of instances with terminating status.
Unassigning (integer) --
The number of instances in the Unassigning state.
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.
Request Syntax
client.stop_stack(
StackId='string'
)
string
[REQUIRED]
The stack ID.
None
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 on user permissions, see Managing User Permissions.
Request Syntax
client.update_my_user_profile(
SshPublicKey='string'
)
string
The user's SSH public key.
None
Requests a description of a set of instances.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_instances(
StackId='string',
LayerId='string',
InstanceIds=[
'string',
]
)
string
A stack ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified stack.
string
A layer ID. If you use this parameter, DescribeInstances returns descriptions of the instances associated with the specified layer.
list
An array of instance IDs to be described. If you use this parameter, DescribeInstances returns a description of the specified instances. Otherwise, it returns a description of every instance.
(string) --
dict
Response Syntax
{
'Instances': [
{
'InstanceId': 'string',
'Ec2InstanceId': 'string',
'VirtualizationType': 'paravirtual'|'hvm',
'Hostname': 'string',
'StackId': 'string',
'LayerIds': [
'string',
],
'SecurityGroupIds': [
'string',
],
'InstanceType': 'string',
'InstanceProfileArn': 'string',
'Status': 'string',
'Os': 'string',
'AmiId': 'string',
'AvailabilityZone': 'string',
'SubnetId': 'string',
'PublicDns': 'string',
'PrivateDns': 'string',
'PublicIp': 'string',
'PrivateIp': 'string',
'ElasticIp': 'string',
'AutoScalingType': 'load'|'timer',
'SshKeyName': 'string',
'SshHostRsaKeyFingerprint': 'string',
'SshHostDsaKeyFingerprint': 'string',
'CreatedAt': 'string',
'LastServiceErrorId': 'string',
'Architecture': 'x86_64'|'i386',
'RootDeviceType': 'ebs'|'instance-store',
'RootDeviceVolumeId': 'string',
'BlockDeviceMappings': [
{
'DeviceName': 'string',
'NoDevice': 'string',
'VirtualName': 'string',
'Ebs': {
'SnapshotId': 'string',
'Iops': 123,
'VolumeSize': 123,
'VolumeType': 'gp2'|'io1'|'standard',
'DeleteOnTermination': True|False
}
},
],
'InstallUpdatesOnBoot': True|False,
'EbsOptimized': True|False,
'ReportedAgentVersion': 'string',
'ReportedOs': {
'Family': 'string',
'Name': 'string',
'Version': 'string'
},
'InfrastructureClass': 'string',
'RegisteredBy': 'string'
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeInstances request.
Instances (list) --
An array of Instance objects that describe the instances.
(dict) --
Describes an instance.
InstanceId (string) --
The instance ID.
Ec2InstanceId (string) --
The ID of the associated Amazon EC2 instance.
VirtualizationType (string) --
The instance's virtualization type, paravirtual or hvm.
Hostname (string) --
The instance host name.
StackId (string) --
The stack ID.
LayerIds (list) --
An array containing the instance layer IDs.
(string) --
SecurityGroupIds (list) --
An array containing the instance security group IDs.
(string) --
InstanceType (string) --
The instance type. AWS OpsWorks supports all instance types except Cluster Compute, Cluster GPU, and High Memory Cluster. For more information, see Instance Families and Types. The parameter values that specify the various types are in the API Name column of the Available Instance Types table.
InstanceProfileArn (string) --
The ARN of the instance's IAM profile. For more information about IAM ARNs, see Using Identifiers.
Status (string) --
The instance status:
booting
connection_lost
online
pending
rebooting
requested
running_setup
setup_failed
shutting_down
start_failed
stopped
stopping
terminated
terminating
Os (string) --
The instance's operating system.
AmiId (string) --
A custom AMI ID to be used to create the instance. The AMI should be based on one of the standard AWS OpsWorks APIs: Amazon Linux, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS. For more information, see Instances
AvailabilityZone (string) --
The instance Availability Zone. For more information, see Regions and Endpoints.
SubnetId (string) --
The instance's subnet ID, if the stack is running in a VPC.
PublicDns (string) --
The instance public DNS name.
PrivateDns (string) --
The instance private DNS name.
PublicIp (string) --
The instance public IP address.
PrivateIp (string) --
The instance private IP address.
ElasticIp (string) --
The instance Elastic IP address.
AutoScalingType (string) --
For load-based or time-based instances, the type.
SshKeyName (string) --
The instance's Amazon EC2 key pair name.
SshHostRsaKeyFingerprint (string) --
The SSH key's RSA fingerprint.
SshHostDsaKeyFingerprint (string) --
The SSH key's DSA fingerprint.
CreatedAt (string) --
The time that the instance was created.
LastServiceErrorId (string) --
The ID of the last service error. For more information, call DescribeServiceErrors.
Architecture (string) --
The instance architecture, "i386" or "x86_64".
RootDeviceType (string) --
The instance's root device type. For more information, see Storage for the Root Device.
RootDeviceVolumeId (string) --
The root device volume ID.
BlockDeviceMappings (list) --
An array of BlockDeviceMapping objects that specify the instance's block device mappings.
(dict) --
Describes a block device mapping. This data type maps directly to the Amazon EC2 BlockDeviceMapping data type.
DeviceName (string) --
The device name that is exposed to the instance, such as /dev/sdh. For the root device, you can use the explicit device name or you can set this parameter to ROOT_DEVICE and AWS OpsWorks will provide the correct device name.
NoDevice (string) --
Suppresses the specified device included in the AMI's block device mapping.
VirtualName (string) --
The virtual device name. For more information, see BlockDeviceMapping.
Ebs (dict) --
An EBSBlockDevice that defines how to configure an Amazon EBS volume when the instance is launched.
SnapshotId (string) --
The snapshot ID.
Iops (integer) --
The number of I/O operations per second (IOPS) that the volume supports. For more information, see EbsBlockDevice.
VolumeSize (integer) --
The volume size, in GiB. For more information, see EbsBlockDevice.
VolumeType (string) --
The volume type. gp2 for General Purpose (SSD) volumes, io1 for Provisioned IOPS (SSD) volumes, and standard for Magnetic volumes.
DeleteOnTermination (boolean) --
Whether the volume is deleted on instance termination.
InstallUpdatesOnBoot (boolean) --
Whether to install operating system and package updates when the instance boots. The default value is true. If this value is set 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.
EbsOptimized (boolean) --
Whether this is an Amazon EBS-optimized instance.
ReportedAgentVersion (string) --
The instance's reported AWS OpsWorks agent version.
ReportedOs (dict) --
For registered instances, the reported operating system.
Family (string) --
The operating system family.
Name (string) --
The operating system name.
Version (string) --
The operating system version.
InfrastructureClass (string) --
For registered instances, the infrastructure class: ec2 or on-premises
RegisteredBy (string) --
For registered instances, who performed the registration.
Disassociates an Elastic IP address from its instance. The address 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.
Request Syntax
client.disassociate_elastic_ip(
ElasticIp='string'
)
string
[REQUIRED]
The Elastic IP address.
None
Unassigns a registered instance from all of it's layers. 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.
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.
Request Syntax
client.unassign_instance(
InstanceId='string'
)
string
[REQUIRED]
The instance ID.
None
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.
Request Syntax
client.update_volume(
VolumeId='string',
Name='string',
MountPoint='string'
)
string
[REQUIRED]
The volume ID.
string
The new name.
string
The new mount point.
None
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.
Request Syntax
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'
)
string
[REQUIRED]
The source stack ID.
string
The cloned stack name.
string
The cloned stack AWS region, such as "us-east-1". For more information about AWS regions, see Regions and Endpoints.
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 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 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.
dict
A list of stack attributes and values as key/value pairs to be added to the cloned stack.
(string) --
(string) --
string
[REQUIRED]
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.
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.
string
The stack's operating system, which must be set to one of the following.
Standard operating systems: an Amazon Linux version such as Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
Custom AMIs: Custom. You specify the custom AMI you want to use when you create instances.
The default option is the current Amazon Linux version.
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.
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.
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.
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 and must escape characters such as '"'.:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON
dict
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.
Name (string) --
The name. This parameter must be set to "Chef".
Version (string) --
The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.
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.
boolean
Whether to use custom cookbooks.
boolean
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 UseOpsworksSecurityGroups you can instead provide your own custom security groups. 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.
dict
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.
Type (string) --
The repository type.
Url (string) --
The source URL.
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 http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
SshKey (string) --
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
Revision (string) --
The application's version. AWS OpsWorks 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.
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 and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
boolean
Whether to clone the source stack's permissions.
list
A list of source stack app IDs to be included in the cloned stack.
(string) --
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.
dict
Response Syntax
{
'StackId': 'string'
}
Response Structure
(dict) --
Contains the response to a CloneStack request.
StackId (string) --
The cloned stack ID.
Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.
For more information, see Deleting 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.
Request Syntax
client.delete_instance(
InstanceId='string',
DeleteElasticIp=True|False,
DeleteVolumes=True|False
)
string
[REQUIRED]
The instance ID.
boolean
Whether to delete the instance Elastic IP address.
boolean
Whether to delete the instance's Amazon EBS volumes.
None
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.
Request Syntax
client.register_volume(
Ec2VolumeId='string',
StackId='string'
)
string
The Amazon EBS volume ID.
string
[REQUIRED]
The stack ID.
dict
Response Syntax
{
'VolumeId': 'string'
}
Response Structure
(dict) --
Contains the response to a RegisterVolume request.
VolumeId (string) --
The volume ID.
Deregisters an Amazon EBS volume. The volume can then be registered by another 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.
Request Syntax
client.deregister_volume(
VolumeId='string'
)
string
[REQUIRED]
The AWS OpsWorks volume ID, which is the GUID that AWS OpsWorks assigned to the instance when you registered the volume with the stack, not the Amazon EC2 volume ID.
None
Describes Amazon RDS instances.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_rds_db_instances(
StackId='string',
RdsDbInstanceArns=[
'string',
]
)
string
[REQUIRED]
The stack ID that the instances are registered with. The operation returns descriptions of all registered Amazon RDS instances.
list
An array containing the ARNs of the instances to be described.
(string) --
dict
Response Syntax
{
'RdsDbInstances': [
{
'RdsDbInstanceArn': 'string',
'DbInstanceIdentifier': 'string',
'DbUser': 'string',
'DbPassword': 'string',
'Region': 'string',
'Address': 'string',
'Engine': 'string',
'StackId': 'string',
'MissingOnRds': True|False
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeRdsDbInstances request.
RdsDbInstances (list) --
An a array of RdsDbInstance objects that describe the instances.
(dict) --
Describes an Amazon RDS instance.
RdsDbInstanceArn (string) --
The instance's ARN.
DbInstanceIdentifier (string) --
The DB instance identifier.
DbUser (string) --
The master user name.
DbPassword (string) --
AWS OpsWorks returns *****FILTERED***** instead of the actual value.
Region (string) --
The instance's AWS region.
Address (string) --
The instance's address.
Engine (string) --
The instance's database engine.
StackId (string) --
The ID of the stack that the instance is registered with.
MissingOnRds (boolean) --
Set to true if AWS OpsWorks was unable to discover the Amazon RDS instance. AWS OpsWorks attempts to discover the instance only once. If this value is set to true, you must deregister the instance and then register it again.
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.
Request Syntax
client.update_layer(
LayerId='string',
Name='string',
Shortname='string',
Attributes={
'string': 'string'
},
CustomInstanceProfileArn='string',
CustomSecurityGroupIds=[
'string',
],
Packages=[
'string',
],
VolumeConfigurations=[
{
'MountPoint': 'string',
'RaidLevel': 123,
'NumberOfDisks': 123,
'Size': 123,
'VolumeType': 'string',
'Iops': 123
},
],
EnableAutoHealing=True|False,
AutoAssignElasticIps=True|False,
AutoAssignPublicIps=True|False,
CustomRecipes={
'Setup': [
'string',
],
'Configure': [
'string',
],
'Deploy': [
'string',
],
'Undeploy': [
'string',
],
'Shutdown': [
'string',
]
},
InstallUpdatesOnBoot=True|False,
UseEbsOptimizedInstances=True|False,
LifecycleEventConfiguration={
'Shutdown': {
'ExecutionTimeout': 123,
'DelayUntilElbConnectionsDrained': True|False
}
}
)
string
[REQUIRED]
The layer ID.
string
The layer name, which is used by the console.
string
For custom layers only, use this parameter to specify the layer's short name, which is used internally by AWS OpsWorksand 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/.
The built-in layers' short names are defined by AWS OpsWorks. For more information, see the Layer Reference
dict
One or more user-defined key/value pairs to be added to the stack attributes.
(string) --
(string) --
string
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.
list
An array containing the layer's custom security group IDs.
(string) --
list
An array of Package objects that describe the layer's packages.
(string) --
list
A VolumeConfigurations object that describes the layer's Amazon EBS volumes.
(dict) --
Describes an Amazon EBS volume configuration.
MountPoint (string) -- [REQUIRED]
The volume mount point. For example "/dev/sdh".
RaidLevel (integer) --
The volume RAID level.
NumberOfDisks (integer) -- [REQUIRED]
The number of disks in the volume.
Size (integer) -- [REQUIRED]
The volume size.
VolumeType (string) --
The volume type:
standard - Magnetic
io1 - Provisioned IOPS (SSD)
gp2 - General Purpose (SSD)
Iops (integer) --
For PIOPS volumes, the IOPS per disk.
boolean
Whether to disable auto healing for the layer.
boolean
Whether to automatically assign an Elastic IP address to the layer's instances. For more information, see How to Edit a Layer.
boolean
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.
dict
A LayerCustomRecipes object that specifies the layer's custom recipes.
Setup (list) --
An array of custom recipe names to be run following a setup event.
(string) --
Configure (list) --
An array of custom recipe names to be run following a configure event.
(string) --
Deploy (list) --
An array of custom recipe names to be run following a deploy event.
(string) --
Undeploy (list) --
An array of custom recipe names to be run following a undeploy event.
(string) --
Shutdown (list) --
An array of custom recipe names to be run following a shutdown event.
(string) --
boolean
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.
boolean
Whether to use Amazon EBS-optimized instances.
dict
Shutdown (dict) --
A ShutdownEventConfiguration object that specifies the Shutdown event configuration.
ExecutionTimeout (integer) --
The time, in seconds, that AWS OpsWorks will wait after triggering a Shutdown event before shutting down an instance.
DelayUntilElbConnectionsDrained (boolean) --
Whether to enable Elastic Load Balancing connection draining. For more information, see Connection Draining
None
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.
Request Syntax
client.update_elastic_ip(
ElasticIp='string',
Name='string'
)
string
[REQUIRED]
The address.
string
The new name.
None
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.
Request Syntax
client.update_stack(
StackId='string',
Name='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,
CustomCookbooksSource={
'Type': 'git'|'svn'|'archive'|'s3',
'Url': 'string',
'Username': 'string',
'Password': 'string',
'SshKey': 'string',
'Revision': 'string'
},
DefaultSshKeyName='string',
DefaultRootDeviceType='ebs'|'instance-store',
UseOpsworksSecurityGroups=True|False
)
string
[REQUIRED]
The stack ID.
string
The stack's new name.
dict
One or more user-defined key/value pairs to be added to the stack attributes.
(string) --
(string) --
string
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. For more information about IAM ARNs, see Using Identifiers.
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.
string
The stack's operating system, which must be set to one of the following.
Standard operating systems: an Amazon Linux version such as Amazon Linux 2014.09, Ubuntu 12.04 LTS, or Ubuntu 14.04 LTS.
Custom AMIs: Custom. You specify the custom AMI you want to use when you create instances.
The default option is the current Amazon Linux version.
string
The stack's new 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.
string
The 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 CreateStack.
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.
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 and must escape characters such as '"'.:
"{\"key1\": \"value1\", \"key2\": \"value2\",...}"
For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration JSON.
dict
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.
Name (string) --
The name. This parameter must be set to "Chef".
Version (string) --
The Chef version. This parameter must be set to 0.9, 11.4, or 11.10. The default value is 11.4.
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.
boolean
Whether the stack uses custom cookbooks.
dict
Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.
Type (string) --
The repository type.
Url (string) --
The source URL.
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 http://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
SshKey (string) --
In requests, the repository's SSH key.
In responses, AWS OpsWorks returns *****FILTERED***** instead of the actual value.
Revision (string) --
The application's version. AWS OpsWorks 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.
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 and Managing SSH Access. You can override this setting by specifying a different key pair, or no key pair, when you create an instance.
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.
boolean
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. UseOpsworksSecurityGroups allows you to instead provide your own custom security groups. 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.
None
Describes a stack's Elastic Load Balancing instances.
Required Permissions: To use this action, an IAM user must have a Show, 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.
Request Syntax
client.describe_elastic_load_balancers(
StackId='string',
LayerIds=[
'string',
]
)
string
A stack ID. The action describes the stack's Elastic Load Balancing instances.
list
A list of layer IDs. The action describes the Elastic Load Balancing instances for the specified layers.
(string) --
dict
Response Syntax
{
'ElasticLoadBalancers': [
{
'ElasticLoadBalancerName': 'string',
'Region': 'string',
'DnsName': 'string',
'StackId': 'string',
'LayerId': 'string',
'VpcId': 'string',
'AvailabilityZones': [
'string',
],
'SubnetIds': [
'string',
],
'Ec2InstanceIds': [
'string',
]
},
]
}
Response Structure
(dict) --
Contains the response to a DescribeElasticLoadBalancers request.
ElasticLoadBalancers (list) --
A list of ElasticLoadBalancer objects that describe the specified Elastic Load Balancing instances.
(dict) --
Describes an Elastic Load Balancing instance.
ElasticLoadBalancerName (string) --
The Elastic Load Balancing instance's name.
Region (string) --
The instance's AWS region.
DnsName (string) --
The instance's public DNS name.
StackId (string) --
The ID of the stack that the instance is associated with.
LayerId (string) --
The ID of the layer that the instance is attached to.
VpcId (string) --
The VPC ID.
AvailabilityZones (list) --
A list of Availability Zones.
(string) --
SubnetIds (list) --
A list of subnet IDs, if the stack is running in a VPC.
(string) --
Ec2InstanceIds (list) --
A list of the EC2 instances that the Elastic Load Balancing instance is managing traffic for.
(string) --
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.
Request Syntax
client.register_rds_db_instance(
StackId='string',
RdsDbInstanceArn='string',
DbUser='string',
DbPassword='string'
)
string
[REQUIRED]
The stack ID.
string
[REQUIRED]
The Amazon RDS instance's ARN.
string
[REQUIRED]
The database's master user name.
string
[REQUIRED]
The database password.
None
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.
Request Syntax
client.set_permission(
StackId='string',
IamUserArn='string',
AllowSsh=True|False,
AllowSudo=True|False,
Level='string'
)
string
[REQUIRED]
The stack ID.
string
[REQUIRED]
The user's IAM ARN.
boolean
The user is allowed to use SSH to communicate with the instance.
boolean
The user is allowed to use sudo to elevate privileges.
string
The user's permission level, which must be set to one of the following strings. You cannot set your own permissions level.
deny
show
deploy
manage
iam_only
For more information on the permissions associated with these levels, see Managing User Permissions
None
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.
Request Syntax
client.register_elastic_ip(
ElasticIp='string',
StackId='string'
)
string
[REQUIRED]
The Elastic IP address.
string
[REQUIRED]
The stack ID.
dict
Response Syntax
{
'ElasticIp': 'string'
}
Response Structure
(dict) --
Contains the response to a RegisterElasticIp request.
ElasticIp (string) --
The Elastic IP address.
Describes a user's SSH information.
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 on user permissions, see Managing User Permissions.
Request Syntax
client.describe_my_user_profile()
dict
Response Syntax
{
'UserProfile': {
'IamUserArn': 'string',
'Name': 'string',
'SshUsername': 'string',
'SshPublicKey': 'string'
}
}
Response Structure
(dict) --
Contains the response to a DescribeMyUserProfile request.
UserProfile (dict) --
A UserProfile object that describes the user's SSH information.
IamUserArn (string) --
The user's IAM ARN.
Name (string) --
The user's name.
SshUsername (string) --
The user's SSH user name.
SshPublicKey (string) --
The user's SSH public key.
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.
Request Syntax
client.stop_instance(
InstanceId='string'
)
string
[REQUIRED]
The instance ID.
None