Class: Aws::OpsWorks::Client
- Inherits:
-
Seahorse::Client::Base
- Object
- Seahorse::Client::Base
- Aws::OpsWorks::Client
- Includes:
- ClientStubs
- Defined in:
- lib/aws-sdk-opsworks/client.rb
Overview
An API client for OpsWorks. To construct a client, you need to configure a ‘:region` and `:credentials`.
client = Aws::OpsWorks::Client.new(
region: region_name,
credentials: credentials,
# ...
)
For details on configuring region and credentials see the [developer guide](/sdk-for-ruby/v3/developer-guide/setup-config.html).
See #initialize for a full list of supported configuration options.
Class Attribute Summary collapse
- .identifier ⇒ Object readonly private
API Operations collapse
-
#assign_instance(params = {}) ⇒ Struct
Assign a registered instance to a layer.
-
#assign_volume(params = {}) ⇒ Struct
Assigns one of the stack’s registered Amazon EBS volumes to a specified instance.
-
#associate_elastic_ip(params = {}) ⇒ Struct
Associates one of the stack’s registered Elastic IP addresses with a specified instance.
-
#attach_elastic_load_balancer(params = {}) ⇒ Struct
Attaches an Elastic Load Balancing load balancer to a specified layer.
-
#clone_stack(params = {}) ⇒ Types::CloneStackResult
Creates a clone of a specified stack.
-
#create_app(params = {}) ⇒ Types::CreateAppResult
Creates an app for a specified stack.
-
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResult
Runs deployment or stack commands.
-
#create_instance(params = {}) ⇒ Types::CreateInstanceResult
Creates an instance in a specified stack.
-
#create_layer(params = {}) ⇒ Types::CreateLayerResult
Creates a layer.
-
#create_stack(params = {}) ⇒ Types::CreateStackResult
Creates a new stack.
-
#create_user_profile(params = {}) ⇒ Types::CreateUserProfileResult
Creates a new user profile.
-
#delete_app(params = {}) ⇒ Struct
Deletes a specified app.
-
#delete_instance(params = {}) ⇒ Struct
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
-
#delete_layer(params = {}) ⇒ Struct
Deletes a specified layer.
-
#delete_stack(params = {}) ⇒ Struct
Deletes a specified stack.
-
#delete_user_profile(params = {}) ⇒ Struct
Deletes a user profile.
-
#deregister_ecs_cluster(params = {}) ⇒ Struct
Deregisters a specified Amazon ECS cluster from a stack.
-
#deregister_elastic_ip(params = {}) ⇒ Struct
Deregisters a specified Elastic IP address.
-
#deregister_instance(params = {}) ⇒ Struct
Deregister an instance from OpsWorks Stacks.
-
#deregister_rds_db_instance(params = {}) ⇒ Struct
Deregisters an Amazon RDS instance.
-
#deregister_volume(params = {}) ⇒ Struct
Deregisters an Amazon EBS volume.
-
#describe_agent_versions(params = {}) ⇒ Types::DescribeAgentVersionsResult
Describes the available OpsWorks Stacks agent versions.
-
#describe_apps(params = {}) ⇒ Types::DescribeAppsResult
Requests a description of a specified set of apps.
-
#describe_commands(params = {}) ⇒ Types::DescribeCommandsResult
Describes the results of specified commands.
-
#describe_deployments(params = {}) ⇒ Types::DescribeDeploymentsResult
Requests a description of a specified set of deployments.
-
#describe_ecs_clusters(params = {}) ⇒ Types::DescribeEcsClustersResult
Describes Amazon ECS clusters that are registered with a stack.
-
#describe_elastic_ips(params = {}) ⇒ Types::DescribeElasticIpsResult
Describes [Elastic IP addresses].
-
#describe_elastic_load_balancers(params = {}) ⇒ Types::DescribeElasticLoadBalancersResult
Describes a stack’s Elastic Load Balancing instances.
-
#describe_instances(params = {}) ⇒ Types::DescribeInstancesResult
Requests a description of a set of instances.
-
#describe_layers(params = {}) ⇒ Types::DescribeLayersResult
Requests a description of one or more layers in a specified stack.
-
#describe_load_based_auto_scaling(params = {}) ⇒ Types::DescribeLoadBasedAutoScalingResult
Describes load-based auto scaling configurations for specified layers.
-
#describe_my_user_profile(params = {}) ⇒ Types::DescribeMyUserProfileResult
Describes a user’s SSH information.
-
#describe_operating_systems(params = {}) ⇒ Types::DescribeOperatingSystemsResponse
Describes the operating systems that are supported by OpsWorks Stacks.
-
#describe_permissions(params = {}) ⇒ Types::DescribePermissionsResult
Describes the permissions for a specified stack.
-
#describe_raid_arrays(params = {}) ⇒ Types::DescribeRaidArraysResult
Describe an instance’s RAID arrays.
-
#describe_rds_db_instances(params = {}) ⇒ Types::DescribeRdsDbInstancesResult
Describes Amazon RDS instances.
-
#describe_service_errors(params = {}) ⇒ Types::DescribeServiceErrorsResult
Describes OpsWorks Stacks service errors.
-
#describe_stack_provisioning_parameters(params = {}) ⇒ Types::DescribeStackProvisioningParametersResult
Requests a description of a stack’s provisioning parameters.
-
#describe_stack_summary(params = {}) ⇒ Types::DescribeStackSummaryResult
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`.
-
#describe_stacks(params = {}) ⇒ Types::DescribeStacksResult
Requests a description of one or more stacks.
-
#describe_time_based_auto_scaling(params = {}) ⇒ Types::DescribeTimeBasedAutoScalingResult
Describes time-based auto scaling configurations for specified instances.
-
#describe_user_profiles(params = {}) ⇒ Types::DescribeUserProfilesResult
Describe specified users.
-
#describe_volumes(params = {}) ⇒ Types::DescribeVolumesResult
Describes an instance’s Amazon EBS volumes.
-
#detach_elastic_load_balancer(params = {}) ⇒ Struct
Detaches a specified Elastic Load Balancing instance from its layer.
-
#disassociate_elastic_ip(params = {}) ⇒ Struct
Disassociates an Elastic IP address from its instance.
-
#get_hostname_suggestion(params = {}) ⇒ Types::GetHostnameSuggestionResult
Gets a generated host name for the specified layer, based on the current host name theme.
-
#grant_access(params = {}) ⇒ Types::GrantAccessResult
<note markdown=“1”> This action can be used only with Windows stacks.
-
#list_tags(params = {}) ⇒ Types::ListTagsResult
Returns a list of tags that are applied to the specified stack or layer.
-
#reboot_instance(params = {}) ⇒ Struct
Reboots a specified instance.
-
#register_ecs_cluster(params = {}) ⇒ Types::RegisterEcsClusterResult
Registers a specified Amazon ECS cluster with a stack.
-
#register_elastic_ip(params = {}) ⇒ Types::RegisterElasticIpResult
Registers an Elastic IP address with a specified stack.
-
#register_instance(params = {}) ⇒ Types::RegisterInstanceResult
Registers instances that were created outside of OpsWorks Stacks with a specified stack.
-
#register_rds_db_instance(params = {}) ⇒ Struct
Registers an Amazon RDS instance with a stack.
-
#register_volume(params = {}) ⇒ Types::RegisterVolumeResult
Registers an Amazon EBS volume with a specified stack.
-
#set_load_based_auto_scaling(params = {}) ⇒ Struct
Specify the load-based auto scaling configuration for a specified layer.
-
#set_permission(params = {}) ⇒ Struct
Specifies a user’s permissions.
-
#set_time_based_auto_scaling(params = {}) ⇒ Struct
Specify the time-based auto scaling configuration for a specified instance.
-
#start_instance(params = {}) ⇒ Struct
Starts a specified instance.
-
#start_stack(params = {}) ⇒ Struct
Starts a stack’s instances.
-
#stop_instance(params = {}) ⇒ Struct
Stops a specified instance.
-
#stop_stack(params = {}) ⇒ Struct
Stops a specified stack.
-
#tag_resource(params = {}) ⇒ Struct
Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks.
-
#unassign_instance(params = {}) ⇒ Struct
Unassigns a registered instance from all layers that are using the instance.
-
#unassign_volume(params = {}) ⇒ Struct
Unassigns an assigned Amazon EBS volume.
-
#untag_resource(params = {}) ⇒ Struct
Removes tags from a specified stack or layer.
-
#update_app(params = {}) ⇒ Struct
Updates a specified app.
-
#update_elastic_ip(params = {}) ⇒ Struct
Updates a registered Elastic IP address’s name.
-
#update_instance(params = {}) ⇒ Struct
Updates a specified instance.
-
#update_layer(params = {}) ⇒ Struct
Updates a specified layer.
-
#update_my_user_profile(params = {}) ⇒ Struct
Updates a user’s SSH public key.
-
#update_rds_db_instance(params = {}) ⇒ Struct
Updates an Amazon RDS instance.
-
#update_stack(params = {}) ⇒ Struct
Updates a specified stack.
-
#update_user_profile(params = {}) ⇒ Struct
Updates a specified user profile.
-
#update_volume(params = {}) ⇒ Struct
Updates an Amazon EBS volume’s name or mount point.
Class Method Summary collapse
- .errors_module ⇒ Object private
Instance Method Summary collapse
- #build_request(operation_name, params = {}) ⇒ Object private
-
#initialize(options) ⇒ Client
constructor
A new instance of Client.
-
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
- #waiter_names ⇒ Object deprecated private Deprecated.
Constructor Details
#initialize(options) ⇒ Client
Returns a new instance of Client.
429 430 431 |
# File 'lib/aws-sdk-opsworks/client.rb', line 429 def initialize(*args) super end |
Class Attribute Details
.identifier ⇒ Object (readonly)
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5902 5903 5904 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5902 def identifier @identifier end |
Class Method Details
.errors_module ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5905 5906 5907 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5905 def errors_module Errors end |
Instance Method Details
#assign_instance(params = {}) ⇒ Struct
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 OpsWorks Stacks.
**Required Permissions**: To use this action, an Identity and Access Management (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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
475 476 477 478 |
# File 'lib/aws-sdk-opsworks/client.rb', line 475 def assign_instance(params = {}, = {}) req = build_request(:assign_instance, params) req.send_request() end |
#assign_volume(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
515 516 517 518 |
# File 'lib/aws-sdk-opsworks/client.rb', line 515 def assign_volume(params = {}, = {}) req = build_request(:assign_volume, params) req.send_request() end |
#associate_elastic_ip(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
554 555 556 557 |
# File 'lib/aws-sdk-opsworks/client.rb', line 554 def associate_elastic_ip(params = {}, = {}) req = build_request(:associate_elastic_ip, params) req.send_request() end |
#attach_elastic_load_balancer(params = {}) ⇒ Struct
Attaches an Elastic Load Balancing load balancer to a specified layer. OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with OpsWorks Stacks. For more information, see [Elastic Load Balancing].
<note markdown=“1”> You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see the [Elastic Load Balancing Developer Guide].
</note>
**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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/layers-elb.html [2]: docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/Welcome.html [3]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
601 602 603 604 |
# File 'lib/aws-sdk-opsworks/client.rb', line 601 def attach_elastic_load_balancer(params = {}, = {}) req = build_request(:attach_elastic_load_balancer, params) req.send_request() end |
#build_request(operation_name, params = {}) ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5757 5758 5759 5760 5761 5762 5763 5764 5765 5766 5767 5768 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5757 def build_request(operation_name, params = {}) handlers = @handlers.for(operation_name) context = Seahorse::Client::RequestContext.new( operation_name: operation_name, operation: config.api.operation(operation_name), client: self, params: params, config: config) context[:gem_name] = 'aws-sdk-opsworks' context[:gem_version] = '1.61.0' Seahorse::Client::Request.new(handlers, context) end |
#clone_stack(params = {}) ⇒ Types::CloneStackResult
Creates a clone of a specified stack. For more information, see [Clone a Stack]. By default, all parameters are set to the values used by the parent stack.
**Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-cloning.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
974 975 976 977 |
# File 'lib/aws-sdk-opsworks/client.rb', line 974 def clone_stack(params = {}, = {}) req = build_request(:clone_stack, params) req.send_request() end |
#create_app(params = {}) ⇒ Types::CreateAppResult
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
1108 1109 1110 1111 |
# File 'lib/aws-sdk-opsworks/client.rb', line 1108 def create_app(params = {}, = {}) req = build_request(:create_app, params) req.send_request() end |
#create_deployment(params = {}) ⇒ Types::CreateDeploymentResult
Runs deployment or stack commands. For more information, see
- Deploying Apps][1
-
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploying.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-commands.html [3]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
1192 1193 1194 1195 |
# File 'lib/aws-sdk-opsworks/client.rb', line 1192 def create_deployment(params = {}, = {}) req = build_request(:create_deployment, params) req.send_request() end |
#create_instance(params = {}) ⇒ Types::CreateInstanceResult
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
1438 1439 1440 1441 |
# File 'lib/aws-sdk-opsworks/client.rb', line 1438 def create_instance(params = {}, = {}) req = build_request(:create_instance, params) req.send_request() end |
#create_layer(params = {}) ⇒ Types::CreateLayerResult
Creates a layer. For more information, see [How to Create a Layer].
<note markdown=“1”> You should use CreateLayer for noncustom layer types such as PHP App Server only if the stack does not have an existing layer of that type. A stack can have at most one instance of each noncustom layer; if you attempt to create a second instance, CreateLayer fails. A stack can have an arbitrary number of custom layers, so you can call CreateLayer as many times as you like for that layer type.
</note>
**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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-create.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
1651 1652 1653 1654 |
# File 'lib/aws-sdk-opsworks/client.rb', line 1651 def create_layer(params = {}, = {}) req = build_request(:create_layer, params) req.send_request() end |
#create_stack(params = {}) ⇒ Types::CreateStackResult
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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-edit.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2018 2019 2020 2021 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2018 def create_stack(params = {}, = {}) req = build_request(:create_stack, params) req.send_request() end |
#create_user_profile(params = {}) ⇒ Types::CreateUserProfileResult
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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2077 2078 2079 2080 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2077 def create_user_profile(params = {}, = {}) req = build_request(:create_user_profile, params) req.send_request() end |
#delete_app(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2108 2109 2110 2111 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2108 def delete_app(params = {}, = {}) req = build_request(:delete_app, params) req.send_request() end |
#delete_instance(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-delete.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2151 2152 2153 2154 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2151 def delete_instance(params = {}, = {}) req = build_request(:delete_instance, params) req.send_request() end |
#delete_layer(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-delete.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2185 2186 2187 2188 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2185 def delete_layer(params = {}, = {}) req = build_request(:delete_layer, params) req.send_request() end |
#delete_stack(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-shutting.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2219 2220 2221 2222 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2219 def delete_stack(params = {}, = {}) req = build_request(:delete_stack, params) req.send_request() end |
#delete_user_profile(params = {}) ⇒ Struct
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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2250 2251 2252 2253 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2250 def delete_user_profile(params = {}, = {}) req = build_request(:delete_user_profile, params) req.send_request() end |
#deregister_ecs_cluster(params = {}) ⇒ Struct
Deregisters a specified Amazon ECS cluster from a 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 [docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html][2].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html#workinglayers-ecscluster-delete [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2284 2285 2286 2287 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2284 def deregister_ecs_cluster(params = {}, = {}) req = build_request(:deregister_ecs_cluster, params) req.send_request() end |
#deregister_elastic_ip(params = {}) ⇒ Struct
Deregisters a specified Elastic IP address. The address can be registered by another stack after it is deregistered. 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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2318 2319 2320 2321 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2318 def deregister_elastic_ip(params = {}, = {}) req = build_request(:deregister_elastic_ip, params) req.send_request() end |
#deregister_instance(params = {}) ⇒ Struct
Deregister an instance from OpsWorks Stacks. The instance can be a registered instance (Amazon EC2 or on-premises) or an instance created with OpsWorks. This action removes the instance from the stack and returns it to your control.
**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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2352 2353 2354 2355 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2352 def deregister_instance(params = {}, = {}) req = build_request(:deregister_instance, params) req.send_request() end |
#deregister_rds_db_instance(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2383 2384 2385 2386 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2383 def deregister_rds_db_instance(params = {}, = {}) req = build_request(:deregister_rds_db_instance, params) req.send_request() end |
#deregister_volume(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2418 2419 2420 2421 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2418 def deregister_volume(params = {}, = {}) req = build_request(:deregister_volume, params) req.send_request() end |
#describe_agent_versions(params = {}) ⇒ Types::DescribeAgentVersionsResult
Describes the available OpsWorks Stacks agent versions. You must specify a stack ID or a configuration manager. ‘DescribeAgentVersions` returns a list of available agent versions for the specified stack or configuration manager.
2459 2460 2461 2462 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2459 def describe_agent_versions(params = {}, = {}) req = build_request(:describe_agent_versions, params) req.send_request() end |
#describe_apps(params = {}) ⇒ Types::DescribeAppsResult
Requests a description of a specified set of apps.
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* app_exists
2542 2543 2544 2545 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2542 def describe_apps(params = {}, = {}) req = build_request(:describe_apps, params) req.send_request() end |
#describe_commands(params = {}) ⇒ Types::DescribeCommandsResult
Describes the results of specified commands.
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2608 2609 2610 2611 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2608 def describe_commands(params = {}, = {}) req = build_request(:describe_commands, params) req.send_request() end |
#describe_deployments(params = {}) ⇒ Types::DescribeDeploymentsResult
Requests a description of a specified set of deployments.
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* deployment_successful
2683 2684 2685 2686 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2683 def describe_deployments(params = {}, = {}) req = build_request(:describe_deployments, params) req.send_request() end |
#describe_ecs_clusters(params = {}) ⇒ Types::DescribeEcsClustersResult
Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the ‘MaxResults` and `NextToken` parameters to paginate the response. However, OpsWorks Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.
**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 permission. For more information about user permissions, see [Managing User Permissions].
This call accepts only one resource-identifying parameter.
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
The returned response is a pageable response and is Enumerable. For details on usage see PageableResponse.
2756 2757 2758 2759 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2756 def describe_ecs_clusters(params = {}, = {}) req = build_request(:describe_ecs_clusters, params) req.send_request() end |
#describe_elastic_ips(params = {}) ⇒ Types::DescribeElasticIpsResult
Describes [Elastic IP addresses].
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/AWSEC2/latest/UserGuide/elastic-ip-addresses-eip.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2819 2820 2821 2822 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2819 def describe_elastic_ips(params = {}, = {}) req = build_request(:describe_elastic_ips, params) req.send_request() end |
#describe_elastic_load_balancers(params = {}) ⇒ Types::DescribeElasticLoadBalancersResult
Describes a stack’s Elastic Load Balancing instances.
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
2879 2880 2881 2882 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2879 def describe_elastic_load_balancers(params = {}, = {}) req = build_request(:describe_elastic_load_balancers, params) req.send_request() end |
#describe_instances(params = {}) ⇒ Types::DescribeInstancesResult
Requests a description of a set of instances.
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
The following waiters are defined for this operation (see #wait_until for detailed usage):
* instance_online
* instance_registered
* instance_stopped
* instance_terminated
2994 2995 2996 2997 |
# File 'lib/aws-sdk-opsworks/client.rb', line 2994 def describe_instances(params = {}, = {}) req = build_request(:describe_instances, params) req.send_request() end |
#describe_layers(params = {}) ⇒ Types::DescribeLayersResult
Requests a description of one or more layers in a specified stack.
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3107 3108 3109 3110 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3107 def describe_layers(params = {}, = {}) req = build_request(:describe_layers, params) req.send_request() end |
#describe_load_based_auto_scaling(params = {}) ⇒ Types::DescribeLoadBasedAutoScalingResult
Describes load-based auto scaling configurations for specified layers.
<note markdown=“1”> You must specify at least one of the parameters.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3167 3168 3169 3170 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3167 def describe_load_based_auto_scaling(params = {}, = {}) req = build_request(:describe_load_based_auto_scaling, params) req.send_request() end |
#describe_my_user_profile(params = {}) ⇒ Types::DescribeMyUserProfileResult
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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3198 3199 3200 3201 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3198 def describe_my_user_profile(params = {}, = {}) req = build_request(:describe_my_user_profile, params) req.send_request() end |
#describe_operating_systems(params = {}) ⇒ Types::DescribeOperatingSystemsResponse
Describes the operating systems that are supported by OpsWorks Stacks.
3226 3227 3228 3229 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3226 def (params = {}, = {}) req = build_request(:describe_operating_systems, params) req.send_request() end |
#describe_permissions(params = {}) ⇒ Types::DescribePermissionsResult
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3277 3278 3279 3280 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3277 def (params = {}, = {}) req = build_request(:describe_permissions, params) req.send_request() end |
#describe_raid_arrays(params = {}) ⇒ Types::DescribeRaidArraysResult
Describe an instance’s RAID arrays.
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3344 3345 3346 3347 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3344 def describe_raid_arrays(params = {}, = {}) req = build_request(:describe_raid_arrays, params) req.send_request() end |
#describe_rds_db_instances(params = {}) ⇒ Types::DescribeRdsDbInstancesResult
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 about user permissions, see [Managing User Permissions].
This call accepts only one resource-identifying parameter.
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3398 3399 3400 3401 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3398 def describe_rds_db_instances(params = {}, = {}) req = build_request(:describe_rds_db_instances, params) req.send_request() end |
#describe_service_errors(params = {}) ⇒ Types::DescribeServiceErrorsResult
Describes OpsWorks Stacks 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 about user permissions, see [Managing User Permissions].
This call accepts only one resource-identifying parameter.
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3458 3459 3460 3461 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3458 def describe_service_errors(params = {}, = {}) req = build_request(:describe_service_errors, params) req.send_request() end |
#describe_stack_provisioning_parameters(params = {}) ⇒ Types::DescribeStackProvisioningParametersResult
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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3498 3499 3500 3501 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3498 def describe_stack_provisioning_parameters(params = {}, = {}) req = build_request(:describe_stack_provisioning_parameters, params) req.send_request() end |
#describe_stack_summary(params = {}) ⇒ Types::DescribeStackSummaryResult
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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3562 3563 3564 3565 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3562 def describe_stack_summary(params = {}, = {}) req = build_request(:describe_stack_summary, params) req.send_request() end |
#describe_stacks(params = {}) ⇒ Types::DescribeStacksResult
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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3636 3637 3638 3639 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3636 def describe_stacks(params = {}, = {}) req = build_request(:describe_stacks, params) req.send_request() end |
#describe_time_based_auto_scaling(params = {}) ⇒ Types::DescribeTimeBasedAutoScalingResult
Describes time-based auto scaling configurations for specified instances.
<note markdown=“1”> You must specify at least one of the parameters.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3694 3695 3696 3697 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3694 def describe_time_based_auto_scaling(params = {}, = {}) req = build_request(:describe_time_based_auto_scaling, params) req.send_request() end |
#describe_user_profiles(params = {}) ⇒ Types::DescribeUserProfilesResult
Describe specified users.
**Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3737 3738 3739 3740 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3737 def describe_user_profiles(params = {}, = {}) req = build_request(:describe_user_profiles, params) req.send_request() end |
#describe_volumes(params = {}) ⇒ Types::DescribeVolumesResult
Describes an instance’s Amazon EBS volumes.
<note markdown=“1”> This call accepts only one resource-identifying parameter.
</note>
**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 about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3811 3812 3813 3814 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3811 def describe_volumes(params = {}, = {}) req = build_request(:describe_volumes, params) req.send_request() end |
#detach_elastic_load_balancer(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3847 3848 3849 3850 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3847 def detach_elastic_load_balancer(params = {}, = {}) req = build_request(:detach_elastic_load_balancer, params) req.send_request() end |
#disassociate_elastic_ip(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3881 3882 3883 3884 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3881 def disassociate_elastic_ip(params = {}, = {}) req = build_request(:disassociate_elastic_ip, params) req.send_request() end |
#get_hostname_suggestion(params = {}) ⇒ Types::GetHostnameSuggestionResult
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
3921 3922 3923 3924 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3921 def get_hostname_suggestion(params = {}, = {}) req = build_request(:get_hostname_suggestion, params) req.send_request() end |
#grant_access(params = {}) ⇒ Types::GrantAccessResult
<note markdown=“1”> This action can be used only with Windows stacks.
</note>
Grants RDP access to a Windows instance for a specified time period.
3963 3964 3965 3966 |
# File 'lib/aws-sdk-opsworks/client.rb', line 3963 def grant_access(params = {}, = {}) req = build_request(:grant_access, params) req.send_request() end |
#list_tags(params = {}) ⇒ Types::ListTagsResult
Returns a list of tags that are applied to the specified stack or layer.
4005 4006 4007 4008 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4005 def (params = {}, = {}) req = build_request(:list_tags, params) req.send_request() end |
#reboot_instance(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4038 4039 4040 4041 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4038 def reboot_instance(params = {}, = {}) req = build_request(:reboot_instance, params) req.send_request() end |
#register_ecs_cluster(params = {}) ⇒ Types::RegisterEcsClusterResult
Registers a specified Amazon ECS cluster with a stack. You can register only one cluster with a stack. A cluster can be registered with only one stack. For more information, see [ Resource Management].
**Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see [ Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-ecscluster.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4083 4084 4085 4086 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4083 def register_ecs_cluster(params = {}, = {}) req = build_request(:register_ecs_cluster, params) req.send_request() end |
#register_elastic_ip(params = {}) ⇒ Types::RegisterElasticIpResult
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4129 4130 4131 4132 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4129 def register_elastic_ip(params = {}, = {}) req = build_request(:register_elastic_ip, params) req.send_request() end |
#register_instance(params = {}) ⇒ Types::RegisterInstanceResult
Registers instances that were created outside of OpsWorks Stacks with a specified stack.
<note markdown=“1”> We do not recommend using this action to register instances. The complete registration operation includes two tasks: installing the OpsWorks Stacks agent on the instance, and registering the instance with the stack. ‘RegisterInstance` handles only the second step. You should instead use the CLI `register` command, which performs the entire registration operation. For more information, see [ Registering an Instance with an OpsWorks Stacks Stack].
</note>
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see [ Preparing the Instance].
**Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/registered-instances-register-registering-preparer.html [3]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4219 4220 4221 4222 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4219 def register_instance(params = {}, = {}) req = build_request(:register_instance, params) req.send_request() end |
#register_rds_db_instance(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4262 4263 4264 4265 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4262 def register_rds_db_instance(params = {}, = {}) req = build_request(:register_rds_db_instance, params) req.send_request() end |
#register_volume(params = {}) ⇒ Types::RegisterVolumeResult
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4307 4308 4309 4310 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4307 def register_volume(params = {}, = {}) req = build_request(:register_volume, params) req.send_request() end |
#set_load_based_auto_scaling(params = {}) ⇒ Struct
Specify the load-based auto scaling configuration for a specified layer. For more information, see [Managing Load with Time-based and Load-based Instances].
<note markdown=“1”> To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
</note>
**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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4382 4383 4384 4385 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4382 def set_load_based_auto_scaling(params = {}, = {}) req = build_request(:set_load_based_auto_scaling, params) req.send_request() end |
#set_permission(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workingsecurity.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4449 4450 4451 4452 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4449 def (params = {}, = {}) req = build_request(:set_permission, params) req.send_request() end |
#set_time_based_auto_scaling(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-autoscaling.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4509 4510 4511 4512 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4509 def set_time_based_auto_scaling(params = {}, = {}) req = build_request(:set_time_based_auto_scaling, params) req.send_request() end |
#start_instance(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4542 4543 4544 4545 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4542 def start_instance(params = {}, = {}) req = build_request(:start_instance, params) req.send_request() end |
#start_stack(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4573 4574 4575 4576 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4573 def start_stack(params = {}, = {}) req = build_request(:start_stack, params) req.send_request() end |
#stop_instance(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-starting.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4619 4620 4621 4622 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4619 def stop_instance(params = {}, = {}) req = build_request(:stop_instance, params) req.send_request() end |
#stop_stack(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4650 4651 4652 4653 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4650 def stop_stack(params = {}, = {}) req = build_request(:stop_stack, params) req.send_request() end |
#tag_resource(params = {}) ⇒ Struct
Apply cost-allocation tags to a specified stack or layer in OpsWorks Stacks. For more information about how tagging works, see [Tags] in the OpsWorks User Guide.
[1]: docs.aws.amazon.com/opsworks/latest/userguide/tagging.html
4700 4701 4702 4703 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4700 def tag_resource(params = {}, = {}) req = build_request(:tag_resource, params) req.send_request() end |
#unassign_instance(params = {}) ⇒ Struct
Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with OpsWorks Stacks.
**Required Permissions**: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4734 4735 4736 4737 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4734 def unassign_instance(params = {}, = {}) req = build_request(:unassign_instance, params) req.send_request() end |
#unassign_volume(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4767 4768 4769 4770 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4767 def unassign_volume(params = {}, = {}) req = build_request(:unassign_volume, params) req.send_request() end |
#untag_resource(params = {}) ⇒ Struct
Removes tags from a specified stack or layer.
4793 4794 4795 4796 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4793 def untag_resource(params = {}, = {}) req = build_request(:untag_resource, params) req.send_request() end |
#update_app(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4910 4911 4912 4913 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4910 def update_app(params = {}, = {}) req = build_request(:update_app, params) req.send_request() end |
#update_elastic_ip(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
4947 4948 4949 4950 |
# File 'lib/aws-sdk-opsworks/client.rb', line 4947 def update_elastic_ip(params = {}, = {}) req = build_request(:update_elastic_ip, params) req.send_request() end |
#update_instance(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
5113 5114 5115 5116 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5113 def update_instance(params = {}, = {}) req = build_request(:update_instance, params) req.send_request() end |
#update_layer(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
5298 5299 5300 5301 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5298 def update_layer(params = {}, = {}) req = build_request(:update_layer, params) req.send_request() end |
#update_my_user_profile(params = {}) ⇒ Struct
Updates a user’s SSH public key.
**Required Permissions**: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
5329 5330 5331 5332 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5329 def update_my_user_profile(params = {}, = {}) req = build_request(:update_my_user_profile, params) req.send_request() end |
#update_rds_db_instance(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
5368 5369 5370 5371 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5368 def update_rds_db_instance(params = {}, = {}) req = build_request(:update_rds_db_instance, params) req.send_request() end |
#update_stack(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
5654 5655 5656 5657 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5654 def update_stack(params = {}, = {}) req = build_request(:update_stack, params) req.send_request() end |
#update_user_profile(params = {}) ⇒ Struct
Updates a specified user profile.
**Required Permissions**: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see [Managing User Permissions].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
5707 5708 5709 5710 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5707 def update_user_profile(params = {}, = {}) req = build_request(:update_user_profile, params) req.send_request() end |
#update_volume(params = {}) ⇒ Struct
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].
[1]: docs.aws.amazon.com/opsworks/latest/userguide/resources.html [2]: docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html
5748 5749 5750 5751 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5748 def update_volume(params = {}, = {}) req = build_request(:update_volume, params) req.send_request() end |
#wait_until(waiter_name, params = {}, options = {}) {|w.waiter| ... } ⇒ Boolean
Polls an API operation until a resource enters a desired state.
## Basic Usage
A waiter will call an API operation until:
-
It is successful
-
It enters a terminal state
-
It makes the maximum number of attempts
In between attempts, the waiter will sleep.
# polls in a loop, sleeping between attempts
client.wait_until(waiter_name, params)
## Configuration
You can configure the maximum number of polling attempts, and the delay (in seconds) between each polling attempt. You can pass configuration as the final arguments hash.
# poll for ~25 seconds
client.wait_until(waiter_name, params, {
max_attempts: 5,
delay: 5,
})
## Callbacks
You can be notified before each polling attempt and before each delay. If you throw ‘:success` or `:failure` from these callbacks, it will terminate the waiter.
started_at = Time.now
client.wait_until(waiter_name, params, {
# disable max attempts
max_attempts: nil,
# poll for 1 hour, instead of a number of attempts
before_wait: -> (attempts, response) do
throw :failure if Time.now - started_at > 3600
end
})
## Handling Errors
When a waiter is unsuccessful, it will raise an error. All of the failure errors extend from Waiters::Errors::WaiterFailed.
begin
client.wait_until(...)
rescue Aws::Waiters::Errors::WaiterFailed
# resource did not enter the desired state in time
end
## Valid Waiters
The following table lists the valid waiter names, the operations they call, and the default ‘:delay` and `:max_attempts` values.
| waiter_name | params | :delay | :max_attempts | | ——————— | —————————– | ——– | ————- | | app_exists | #describe_apps | 1 | 40 | | deployment_successful | #describe_deployments | 15 | 40 | | instance_online | #describe_instances | 15 | 40 | | instance_registered | #describe_instances | 15 | 40 | | instance_stopped | #describe_instances | 15 | 40 | | instance_terminated | #describe_instances | 15 | 40 |
5863 5864 5865 5866 5867 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5863 def wait_until(waiter_name, params = {}, = {}) w = waiter(waiter_name, ) yield(w.waiter) if block_given? # deprecated w.wait(params) end |
#waiter_names ⇒ Object
This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.
5871 5872 5873 |
# File 'lib/aws-sdk-opsworks/client.rb', line 5871 def waiter_names waiters.keys end |