Package com.amazonaws.services.opsworks

Class AbstractAWSOpsWorks

java.lang.Object
com.amazonaws.services.opsworks.AbstractAWSOpsWorks
All Implemented Interfaces:
AWSOpsWorks
Direct Known Subclasses:
AbstractAWSOpsWorksAsync
public class AbstractAWSOpsWorks extends Object implements AWSOpsWorks
Abstract implementation of AWSOpsWorks. Convenient method forms pass through to the corresponding overload that takes a request object, which throws an UnsupportedOperationException.

  • Constructor Details

    • AbstractAWSOpsWorks

      protected AbstractAWSOpsWorks()

  • Method Details

    • setEndpoint

      public void setEndpoint(String endpoint)
      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 interface AWSOpsWorks
      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

      public void setRegion(Region region)
      Description copied from interface: AWSOpsWorks
      An alternative to AWSOpsWorks.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 interface AWSOpsWorks
      Parameters:
      region - The region this client will communicate with. See Region.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

      public AssignInstanceResult assignInstance(AssignInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the AssignInstance operation returned by the service.

    • assignVolume

      public AssignVolumeResult assignVolume(AssignVolumeRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the AssignVolume operation returned by the service.

    • associateElasticIp

      public AssociateElasticIpResult associateElasticIp(AssociateElasticIpRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the AttachElasticLoadBalancer operation returned by the service.

    • cloneStack

      public CloneStackResult cloneStack(CloneStackRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the CloneStack operation returned by the service.

    • createApp

      public CreateAppResult createApp(CreateAppRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the CreateApp operation returned by the service.

    • createDeployment

      public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the CreateDeployment operation returned by the service.

    • createInstance

      public CreateInstanceResult createInstance(CreateInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the CreateInstance operation returned by the service.

    • createLayer

      public CreateLayerResult createLayer(CreateLayerRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the CreateLayer operation returned by the service.

    • createStack

      public CreateStackResult createStack(CreateStackRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the CreateStack operation returned by the service.

    • createUserProfile

      public CreateUserProfileResult createUserProfile(CreateUserProfileRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the CreateUserProfile operation returned by the service.

    • deleteApp

      public DeleteAppResult deleteApp(DeleteAppRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeleteApp operation returned by the service.

    • deleteInstance

      public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeleteInstance operation returned by the service.

    • deleteLayer

      public DeleteLayerResult deleteLayer(DeleteLayerRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeleteLayer operation returned by the service.

    • deleteStack

      public DeleteStackResult deleteStack(DeleteStackRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeleteStack operation returned by the service.

    • deleteUserProfile

      public DeleteUserProfileResult deleteUserProfile(DeleteUserProfileRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeleteUserProfile operation returned by the service.

    • deregisterEcsCluster

      public DeregisterEcsClusterResult deregisterEcsCluster(DeregisterEcsClusterRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeregisterEcsCluster operation returned by the service.

    • deregisterElasticIp

      public DeregisterElasticIpResult deregisterElasticIp(DeregisterElasticIpRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeregisterElasticIp operation returned by the service.

    • deregisterInstance

      public DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeregisterRdsDbInstance operation returned by the service.

    • deregisterVolume

      public DeregisterVolumeResult deregisterVolume(DeregisterVolumeRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DeregisterVolume operation returned by the service.

    • describeAgentVersions

      public DescribeAgentVersionsResult describeAgentVersions(DescribeAgentVersionsRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeAgentVersions operation returned by the service.

    • describeApps

      public DescribeAppsResult describeApps(DescribeAppsRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeApps operation returned by the service.

    • describeCommands

      public DescribeCommandsResult describeCommands(DescribeCommandsRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeCommands operation returned by the service.

    • describeDeployments

      public DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeDeployments operation returned by the service.

    • describeEcsClusters

      public DescribeEcsClustersResult describeEcsClusters(DescribeEcsClustersRequest request)
      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 and NextToken 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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeEcsClusters operation returned by the service.

    • describeElasticIps

      public DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeElasticLoadBalancers operation returned by the service.

    • describeInstances

      public DescribeInstancesResult describeInstances(DescribeInstancesRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeInstances operation returned by the service.

    • describeLayers

      public DescribeLayersResult describeLayers(DescribeLayersRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeLoadBasedAutoScaling operation returned by the service.

    • describeMyUserProfile

      public DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeMyUserProfile operation returned by the service.

    • describePermissions

      public DescribePermissionsResult describePermissions(DescribePermissionsRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribePermissions operation returned by the service.

    • describeRaidArrays

      public DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeRaidArrays operation returned by the service.

    • describeRdsDbInstances

      public DescribeRdsDbInstancesResult describeRdsDbInstances(DescribeRdsDbInstancesRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeRdsDbInstances operation returned by the service.

    • describeServiceErrors

      public DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeStackProvisioningParameters operation returned by the service.

    • describeStackSummary

      public DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest request)
      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 or online.

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

      Specified by:
      describeStackSummary in interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeStackSummary operation returned by the service.

    • describeStacks

      public DescribeStacksResult describeStacks(DescribeStacksRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeTimeBasedAutoScaling operation returned by the service.

    • describeUserProfiles

      public DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DescribeUserProfiles operation returned by the service.

    • describeVolumes

      public DescribeVolumesResult describeVolumes(DescribeVolumesRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DetachElasticLoadBalancer operation returned by the service.

    • disassociateElasticIp

      public DisassociateElasticIpResult disassociateElasticIp(DisassociateElasticIpRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the DisassociateElasticIp operation returned by the service.

    • getHostnameSuggestion

      public GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the GetHostnameSuggestion operation returned by the service.

    • grantAccess

      public GrantAccessResult grantAccess(GrantAccessRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the GrantAccess operation returned by the service.

    • rebootInstance

      public RebootInstanceResult rebootInstance(RebootInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the RebootInstance operation returned by the service.

    • registerEcsCluster

      public RegisterEcsClusterResult registerEcsCluster(RegisterEcsClusterRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the RegisterEcsCluster operation returned by the service.

    • registerElasticIp

      public RegisterElasticIpResult registerElasticIp(RegisterElasticIpRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the RegisterElasticIp operation returned by the service.

    • registerInstance

      public RegisterInstanceResult registerInstance(RegisterInstanceRequest request)
      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 CLI register 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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the RegisterInstance operation returned by the service.

    • registerRdsDbInstance

      public RegisterRdsDbInstanceResult registerRdsDbInstance(RegisterRdsDbInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the RegisterRdsDbInstance operation returned by the service.

    • registerVolume

      public RegisterVolumeResult registerVolume(RegisterVolumeRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the SetLoadBasedAutoScaling operation returned by the service.

    • setPermission

      public SetPermissionResult setPermission(SetPermissionRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the SetTimeBasedAutoScaling operation returned by the service.

    • startInstance

      public StartInstanceResult startInstance(StartInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the StartInstance operation returned by the service.

    • startStack

      public StartStackResult startStack(StartStackRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the StartStack operation returned by the service.

    • stopInstance

      public StopInstanceResult stopInstance(StopInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the StopInstance operation returned by the service.

    • stopStack

      public StopStackResult stopStack(StopStackRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the StopStack operation returned by the service.

    • unassignInstance

      public UnassignInstanceResult unassignInstance(UnassignInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UnassignInstance operation returned by the service.

    • unassignVolume

      public UnassignVolumeResult unassignVolume(UnassignVolumeRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UnassignVolume operation returned by the service.

    • updateApp

      public UpdateAppResult updateApp(UpdateAppRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UpdateApp operation returned by the service.

    • updateElasticIp

      public UpdateElasticIpResult updateElasticIp(UpdateElasticIpRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UpdateElasticIp operation returned by the service.

    • updateInstance

      public UpdateInstanceResult updateInstance(UpdateInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UpdateInstance operation returned by the service.

    • updateLayer

      public UpdateLayerResult updateLayer(UpdateLayerRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UpdateLayer operation returned by the service.

    • updateMyUserProfile

      public UpdateMyUserProfileResult updateMyUserProfile(UpdateMyUserProfileRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UpdateMyUserProfile operation returned by the service.

    • updateRdsDbInstance

      public UpdateRdsDbInstanceResult updateRdsDbInstance(UpdateRdsDbInstanceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UpdateRdsDbInstance operation returned by the service.

    • updateStack

      public UpdateStackResult updateStack(UpdateStackRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UpdateStack operation returned by the service.

    • updateUserProfile

      public UpdateUserProfileResult updateUserProfile(UpdateUserProfileRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      Returns:
      Result of the UpdateUserProfile operation returned by the service.

    • updateVolume

      public UpdateVolumeResult updateVolume(UpdateVolumeRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request -
      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 interface AWSOpsWorks

    • getCachedResponseMetadata

      public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
      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 interface AWSOpsWorks
      Parameters:
      request - The originally executed request.
      Returns:
      The response metadata for the specified request, or null if none is available.