Class AbstractAWSOpsWorks
- All Implemented Interfaces:
AWSOpsWorks
- Direct Known Subclasses:
AbstractAWSOpsWorksAsync
AWSOpsWorks
. Convenient method forms pass
through to the corresponding overload that takes a request object, which
throws an UnsupportedOperationException
.-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionassignInstance
(AssignInstanceRequest request) Assign a registered instance to a layer.assignVolume
(AssignVolumeRequest request) Assigns one of the stack's registered Amazon EBS volumes to a specified instance.Associates one of the stack's registered Elastic IP addresses with a specified instance.Attaches an Elastic Load Balancing load balancer to a specified layer.cloneStack
(CloneStackRequest request) Creates a clone of a specified stack.createApp
(CreateAppRequest request) Creates an app for a specified stack.createDeployment
(CreateDeploymentRequest request) Runs deployment or stack commands.createInstance
(CreateInstanceRequest request) Creates an instance in a specified stack.createLayer
(CreateLayerRequest request) Creates a layer.createStack
(CreateStackRequest request) Creates a new stack.Creates a new user profile.deleteApp
(DeleteAppRequest request) Deletes a specified app.deleteInstance
(DeleteInstanceRequest request) Deletes a specified instance, which terminates the associated Amazon EC2 instance.deleteLayer
(DeleteLayerRequest request) Deletes a specified layer.deleteStack
(DeleteStackRequest request) Deletes a specified stack.Deletes a user profile.Deregisters a specified Amazon ECS cluster from a stack.Deregisters a specified Elastic IP address.Deregister a registered Amazon EC2 or on-premises instance.Deregisters an Amazon RDS instance.deregisterVolume
(DeregisterVolumeRequest request) Deregisters an Amazon EBS volume.Describes the available AWS OpsWorks agent versions.describeApps
(DescribeAppsRequest request) Requests a description of a specified set of apps.describeCommands
(DescribeCommandsRequest request) Describes the results of specified commands.Requests a description of a specified set of deployments.Describes Amazon ECS clusters that are registered with a stack.Describes Elastic IP addresses.Describes a stack's Elastic Load Balancing instances.Requests a description of a set of instances.describeLayers
(DescribeLayersRequest request) Requests a description of one or more layers in a specified stack.Describes load-based auto scaling configurations for specified layers.Describes a user's SSH information.Describes the permissions for a specified stack.Describe an instance's RAID arrays.Describes Amazon RDS instances.Describes AWS OpsWorks service errors.Requests a description of a stack's provisioning parameters.describeStacks
(DescribeStacksRequest request) Requests a description of one or more stacks.Describes the number of layers and apps in a specified stack, and the number of instances in each state, such asrunning_setup
oronline
.Describes time-based auto scaling configurations for specified instances.Describe specified users.describeVolumes
(DescribeVolumesRequest request) Describes an instance's Amazon EBS volumes.Detaches a specified Elastic Load Balancing instance from its layer.Disassociates an Elastic IP address from its instance.Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected.Gets a generated host name for the specified layer, based on the current host name theme.grantAccess
(GrantAccessRequest request) This action can be used only with Windows stacks. rebootInstance
(RebootInstanceRequest request) Reboots a specified instance.Registers a specified Amazon ECS cluster with a stack.Registers an Elastic IP address with a specified stack.registerInstance
(RegisterInstanceRequest request) Registers instances with a specified stack that were created outside of AWS OpsWorks.Registers an Amazon RDS instance with a stack.registerVolume
(RegisterVolumeRequest request) Registers an Amazon EBS volume with a specified stack.void
setEndpoint
(String endpoint) Overrides the default endpoint for this client ("https://opsworks.us-east-1.amazonaws.com").Specify the load-based auto scaling configuration for a specified layer.setPermission
(SetPermissionRequest request) Specifies a user's permissions.void
An alternative toAWSOpsWorks.setEndpoint(String)
, sets the regional endpoint for this client's service calls.Specify the time-based auto scaling configuration for a specified instance.void
shutdown()
Shuts down this client object, releasing any resources that might be held open.startInstance
(StartInstanceRequest request) Starts a specified instance.startStack
(StartStackRequest request) Starts a stack's instances.stopInstance
(StopInstanceRequest request) Stops a specified instance.stopStack
(StopStackRequest request) Stops a specified stack.unassignInstance
(UnassignInstanceRequest request) Unassigns a registered instance from all of it's layers.unassignVolume
(UnassignVolumeRequest request) Unassigns an assigned Amazon EBS volume.updateApp
(UpdateAppRequest request) Updates a specified app.updateElasticIp
(UpdateElasticIpRequest request) Updates a registered Elastic IP address's name.updateInstance
(UpdateInstanceRequest request) Updates a specified instance.updateLayer
(UpdateLayerRequest request) Updates a specified layer.Updates a user's SSH public key.Updates an Amazon RDS instance.updateStack
(UpdateStackRequest request) Updates a specified stack.Updates a specified user profile.updateVolume
(UpdateVolumeRequest request) Updates an Amazon EBS volume's name or mount point.
-
Constructor Details
-
AbstractAWSOpsWorks
protected AbstractAWSOpsWorks()
-
-
Method Details
-
setEndpoint
Description copied from interface:AWSOpsWorks
Overrides the default endpoint for this client ("https://opsworks.us-east-1.amazonaws.com"). Callers can use this method to control which AWS region they want to work with.Callers can pass in just the endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://opsworks.us-east-1.amazonaws.com"). If the protocol is not specified here, the default protocol from this client's
ClientConfiguration
will be used, which by default is HTTPS.For more information on using AWS regions with the AWS SDK for Java, and a complete list of all available endpoints for all AWS services, see: http://developer.amazonwebservices.com/connect/entry.jspa?externalID= 3912
This method is not threadsafe. An endpoint should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setEndpoint
in interfaceAWSOpsWorks
- Parameters:
endpoint
- The endpoint (ex: "opsworks.us-east-1.amazonaws.com") or a full URL, including the protocol (ex: "https://opsworks.us-east-1.amazonaws.com") of the region specific AWS endpoint this client will communicate with.
-
setRegion
Description copied from interface:AWSOpsWorks
An alternative toAWSOpsWorks.setEndpoint(String)
, sets the regional endpoint for this client's service calls. Callers can use this method to control which AWS region they want to work with.By default, all service endpoints in all regions use the https protocol. To use http instead, specify it in the
ClientConfiguration
supplied at construction.This method is not threadsafe. A region should be configured when the client is created and before any service requests are made. Changing it afterwards creates inevitable race conditions for any service requests in transit or retrying.
- Specified by:
setRegion
in interfaceAWSOpsWorks
- Parameters:
region
- The region this client will communicate with. SeeRegion.getRegion(com.amazonaws.regions.Regions)
for accessing a given region. Must not be null and must be a region where the service is available.- See Also:
-
assignInstance
Description copied from interface:AWSOpsWorks
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 AWS 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.
- Specified by:
assignInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the AssignInstance operation returned by the service.
-
assignVolume
Description copied from interface:AWSOpsWorks
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.
- Specified by:
assignVolume
in interfaceAWSOpsWorks
- Returns:
- Result of the AssignVolume operation returned by the service.
-
associateElasticIp
Description copied from interface:AWSOpsWorks
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.
- Specified by:
associateElasticIp
in interfaceAWSOpsWorks
- Returns:
- Result of the AssociateElasticIp operation returned by the service.
-
attachElasticLoadBalancer
public AttachElasticLoadBalancerResult attachElasticLoadBalancer(AttachElasticLoadBalancerRequest request) Description copied from interface:AWSOpsWorks
Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.
You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.
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.
- Specified by:
attachElasticLoadBalancer
in interfaceAWSOpsWorks
- Returns:
- Result of the AttachElasticLoadBalancer operation returned by the service.
-
cloneStack
Description copied from interface:AWSOpsWorks
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 on user permissions, see Managing User Permissions.
- Specified by:
cloneStack
in interfaceAWSOpsWorks
- Returns:
- Result of the CloneStack operation returned by the service.
-
createApp
Description copied from interface:AWSOpsWorks
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.
- Specified by:
createApp
in interfaceAWSOpsWorks
- Returns:
- Result of the CreateApp operation returned by the service.
-
createDeployment
Description copied from interface:AWSOpsWorks
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.
- Specified by:
createDeployment
in interfaceAWSOpsWorks
- Returns:
- Result of the CreateDeployment operation returned by the service.
-
createInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
createInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the CreateInstance operation returned by the service.
-
createLayer
Description copied from interface:AWSOpsWorks
Creates a layer. For more information, see How to Create a Layer.
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.
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.
- Specified by:
createLayer
in interfaceAWSOpsWorks
- Returns:
- Result of the CreateLayer operation returned by the service.
-
createStack
Description copied from interface:AWSOpsWorks
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.
- Specified by:
createStack
in interfaceAWSOpsWorks
- Returns:
- Result of the CreateStack operation returned by the service.
-
createUserProfile
Description copied from interface:AWSOpsWorks
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.
- Specified by:
createUserProfile
in interfaceAWSOpsWorks
- Returns:
- Result of the CreateUserProfile operation returned by the service.
-
deleteApp
Description copied from interface:AWSOpsWorks
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.
- Specified by:
deleteApp
in interfaceAWSOpsWorks
- Returns:
- Result of the DeleteApp operation returned by the service.
-
deleteInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
deleteInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the DeleteInstance operation returned by the service.
-
deleteLayer
Description copied from interface:AWSOpsWorks
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.
- Specified by:
deleteLayer
in interfaceAWSOpsWorks
- Returns:
- Result of the DeleteLayer operation returned by the service.
-
deleteStack
Description copied from interface:AWSOpsWorks
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.
- Specified by:
deleteStack
in interfaceAWSOpsWorks
- Returns:
- Result of the DeleteStack operation returned by the service.
-
deleteUserProfile
Description copied from interface:AWSOpsWorks
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.
- Specified by:
deleteUserProfile
in interfaceAWSOpsWorks
- Returns:
- Result of the DeleteUserProfile operation returned by the service.
-
deregisterEcsCluster
Description copied from interface:AWSOpsWorks
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 .
- Specified by:
deregisterEcsCluster
in interfaceAWSOpsWorks
- Returns:
- Result of the DeregisterEcsCluster operation returned by the service.
-
deregisterElasticIp
Description copied from interface:AWSOpsWorks
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.
- Specified by:
deregisterElasticIp
in interfaceAWSOpsWorks
- Returns:
- Result of the DeregisterElasticIp operation returned by the service.
-
deregisterInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
deregisterInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the DeregisterInstance operation returned by the service.
-
deregisterRdsDbInstance
public DeregisterRdsDbInstanceResult deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest request) Description copied from interface:AWSOpsWorks
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.
- Specified by:
deregisterRdsDbInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the DeregisterRdsDbInstance operation returned by the service.
-
deregisterVolume
Description copied from interface:AWSOpsWorks
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.
- Specified by:
deregisterVolume
in interfaceAWSOpsWorks
- Returns:
- Result of the DeregisterVolume operation returned by the service.
-
describeAgentVersions
Description copied from interface:AWSOpsWorks
Describes the available AWS OpsWorks 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.- Specified by:
describeAgentVersions
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeAgentVersions operation returned by the service.
-
describeApps
Description copied from interface:AWSOpsWorks
Requests a description of a specified set of apps.
You must specify at least one of the 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.
- Specified by:
describeApps
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeApps operation returned by the service.
-
describeCommands
Description copied from interface:AWSOpsWorks
Describes the results of specified commands.
You must specify at least one of the 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.
- Specified by:
describeCommands
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeCommands operation returned by the service.
-
describeDeployments
Description copied from interface:AWSOpsWorks
Requests a description of a specified set of deployments.
You must specify at least one of the 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.
- Specified by:
describeDeployments
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeDeployments operation returned by the service.
-
describeEcsClusters
Description copied from interface:AWSOpsWorks
Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the
MaxResults
andNextToken
parameters to paginate the response. However, AWS OpsWorks 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 on user permissions, see Managing User Permissions.
- Specified by:
describeEcsClusters
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeEcsClusters operation returned by the service.
-
describeElasticIps
Description copied from interface:AWSOpsWorks
Describes Elastic IP addresses.
You must specify at least one of the 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.
- Specified by:
describeElasticIps
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeElasticIps operation returned by the service.
-
describeElasticLoadBalancers
public DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest request) Description copied from interface:AWSOpsWorks
Describes a stack's Elastic Load Balancing instances.
You must specify at least one of the 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.
- Specified by:
describeElasticLoadBalancers
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeElasticLoadBalancers operation returned by the service.
-
describeInstances
Description copied from interface:AWSOpsWorks
Requests a description of a set of instances.
You must specify at least one of the 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.
- Specified by:
describeInstances
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeInstances operation returned by the service.
-
describeLayers
Description copied from interface:AWSOpsWorks
Requests a description of one or more layers in a specified stack.
You must specify at least one of the 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.
- Specified by:
describeLayers
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeLayers operation returned by the service.
-
describeLoadBasedAutoScaling
public DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest request) Description copied from interface:AWSOpsWorks
Describes load-based auto scaling configurations for specified layers.
You must specify at least one of the 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.
- Specified by:
describeLoadBasedAutoScaling
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeLoadBasedAutoScaling operation returned by the service.
-
describeMyUserProfile
Description copied from interface:AWSOpsWorks
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.
- Specified by:
describeMyUserProfile
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeMyUserProfile operation returned by the service.
-
describePermissions
Description copied from interface:AWSOpsWorks
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.
- Specified by:
describePermissions
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribePermissions operation returned by the service.
-
describeRaidArrays
Description copied from interface:AWSOpsWorks
Describe an instance's RAID arrays.
You must specify at least one of the 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.
- Specified by:
describeRaidArrays
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeRaidArrays operation returned by the service.
-
describeRdsDbInstances
Description copied from interface:AWSOpsWorks
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.
- Specified by:
describeRdsDbInstances
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeRdsDbInstances operation returned by the service.
-
describeServiceErrors
Description copied from interface:AWSOpsWorks
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.
- Specified by:
describeServiceErrors
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeServiceErrors operation returned by the service.
-
describeStackProvisioningParameters
public DescribeStackProvisioningParametersResult describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest request) Description copied from interface:AWSOpsWorks
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.
- Specified by:
describeStackProvisioningParameters
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeStackProvisioningParameters operation returned by the service.
-
describeStackSummary
Description copied from interface:AWSOpsWorks
Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as
running_setup
oronline
.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.
- Specified by:
describeStackSummary
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeStackSummary operation returned by the service.
-
describeStacks
Description copied from interface:AWSOpsWorks
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.
- Specified by:
describeStacks
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeStacks operation returned by the service.
-
describeTimeBasedAutoScaling
public DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest request) Description copied from interface:AWSOpsWorks
Describes time-based auto scaling configurations for specified instances.
You must specify at least one of the 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.
- Specified by:
describeTimeBasedAutoScaling
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeTimeBasedAutoScaling operation returned by the service.
-
describeUserProfiles
Description copied from interface:AWSOpsWorks
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.
- Specified by:
describeUserProfiles
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeUserProfiles operation returned by the service.
-
describeVolumes
Description copied from interface:AWSOpsWorks
Describes an instance's Amazon EBS volumes.
You must specify at least one of the 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.
- Specified by:
describeVolumes
in interfaceAWSOpsWorks
- Returns:
- Result of the DescribeVolumes operation returned by the service.
-
detachElasticLoadBalancer
public DetachElasticLoadBalancerResult detachElasticLoadBalancer(DetachElasticLoadBalancerRequest request) Description copied from interface:AWSOpsWorks
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.
- Specified by:
detachElasticLoadBalancer
in interfaceAWSOpsWorks
- Returns:
- Result of the DetachElasticLoadBalancer operation returned by the service.
-
disassociateElasticIp
Description copied from interface:AWSOpsWorks
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.
- Specified by:
disassociateElasticIp
in interfaceAWSOpsWorks
- Returns:
- Result of the DisassociateElasticIp operation returned by the service.
-
getHostnameSuggestion
Description copied from interface:AWSOpsWorks
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.
- Specified by:
getHostnameSuggestion
in interfaceAWSOpsWorks
- Returns:
- Result of the GetHostnameSuggestion operation returned by the service.
-
grantAccess
Description copied from interface:AWSOpsWorks
This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period.
- Specified by:
grantAccess
in interfaceAWSOpsWorks
- Returns:
- Result of the GrantAccess operation returned by the service.
-
rebootInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
rebootInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the RebootInstance operation returned by the service.
-
registerEcsCluster
Description copied from interface:AWSOpsWorks
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.
- Specified by:
registerEcsCluster
in interfaceAWSOpsWorks
- Returns:
- Result of the RegisterEcsCluster operation returned by the service.
-
registerElasticIp
Description copied from interface:AWSOpsWorks
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.
- Specified by:
registerElasticIp
in interfaceAWSOpsWorks
- Returns:
- Result of the RegisterElasticIp operation returned by the service.
-
registerInstance
Description copied from interface:AWSOpsWorks
Registers instances with a specified stack that were created outside of AWS OpsWorks.
We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance
handles only the second step. You should instead use the AWS CLIregister
command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks 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.
- Specified by:
registerInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the RegisterInstance operation returned by the service.
-
registerRdsDbInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
registerRdsDbInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the RegisterRdsDbInstance operation returned by the service.
-
registerVolume
Description copied from interface:AWSOpsWorks
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.
- Specified by:
registerVolume
in interfaceAWSOpsWorks
- Returns:
- Result of the RegisterVolume operation returned by the service.
-
setLoadBasedAutoScaling
public SetLoadBasedAutoScalingResult setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest request) Description copied from interface:AWSOpsWorks
Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.
To use load-based auto scaling, you must create a set of load-based auto scaling instances. Load-based auto scaling operates only on the instances from that set, so you must ensure that you have created enough instances to handle the maximum anticipated load.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
- Specified by:
setLoadBasedAutoScaling
in interfaceAWSOpsWorks
- Returns:
- Result of the SetLoadBasedAutoScaling operation returned by the service.
-
setPermission
Description copied from interface:AWSOpsWorks
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.
- Specified by:
setPermission
in interfaceAWSOpsWorks
- Returns:
- Result of the SetPermission operation returned by the service.
-
setTimeBasedAutoScaling
public SetTimeBasedAutoScalingResult setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest request) Description copied from interface:AWSOpsWorks
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.
- Specified by:
setTimeBasedAutoScaling
in interfaceAWSOpsWorks
- Returns:
- Result of the SetTimeBasedAutoScaling operation returned by the service.
-
startInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
startInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the StartInstance operation returned by the service.
-
startStack
Description copied from interface:AWSOpsWorks
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.
- Specified by:
startStack
in interfaceAWSOpsWorks
- Returns:
- Result of the StartStack operation returned by the service.
-
stopInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
stopInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the StopInstance operation returned by the service.
-
stopStack
Description copied from interface:AWSOpsWorks
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.
- Specified by:
stopStack
in interfaceAWSOpsWorks
- Returns:
- Result of the StopStack operation returned by the service.
-
unassignInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
unassignInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the UnassignInstance operation returned by the service.
-
unassignVolume
Description copied from interface:AWSOpsWorks
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.
- Specified by:
unassignVolume
in interfaceAWSOpsWorks
- Returns:
- Result of the UnassignVolume operation returned by the service.
-
updateApp
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateApp
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateApp operation returned by the service.
-
updateElasticIp
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateElasticIp
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateElasticIp operation returned by the service.
-
updateInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateInstance operation returned by the service.
-
updateLayer
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateLayer
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateLayer operation returned by the service.
-
updateMyUserProfile
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateMyUserProfile
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateMyUserProfile operation returned by the service.
-
updateRdsDbInstance
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateRdsDbInstance
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateRdsDbInstance operation returned by the service.
-
updateStack
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateStack
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateStack operation returned by the service.
-
updateUserProfile
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateUserProfile
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateUserProfile operation returned by the service.
-
updateVolume
Description copied from interface:AWSOpsWorks
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.
- Specified by:
updateVolume
in interfaceAWSOpsWorks
- Returns:
- Result of the UpdateVolume operation returned by the service.
-
shutdown
public void shutdown()Description copied from interface:AWSOpsWorks
Shuts down this client object, releasing any resources that might be held open. This is an optional method, and callers are not expected to call it, but can if they want to explicitly release any open resources. Once a client has been shutdown, it should not be used to make any more requests.- Specified by:
shutdown
in interfaceAWSOpsWorks
-
getCachedResponseMetadata
Description copied from interface:AWSOpsWorks
Returns additional metadata for a previously executed successful request, typically used for debugging issues where a service isn't acting as expected. This data isn't considered part of the result data returned by an operation, so it's available through this separate, diagnostic interface.Response metadata is only cached for a limited period of time, so if you need to access this extra diagnostic information for an executed request, you should use this method to retrieve it as soon as possible after executing a request.
- Specified by:
getCachedResponseMetadata
in interfaceAWSOpsWorks
- Parameters:
request
- The originally executed request.- Returns:
- The response metadata for the specified request, or null if none is available.
-