@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class AbstractAWSOpsWorks extends Object implements AWSOpsWorks
AWSOpsWorks
. Convenient method forms pass through to the corresponding overload
that takes a request object, which throws an UnsupportedOperationException
.ENDPOINT_PREFIX
Modifier and Type | Method and Description |
---|---|
AssignInstanceResult |
assignInstance(AssignInstanceRequest request)
Assign a registered instance to a layer.
|
AssignVolumeResult |
assignVolume(AssignVolumeRequest request)
Assigns one of the stack's registered Amazon EBS volumes to a specified instance.
|
AssociateElasticIpResult |
associateElasticIp(AssociateElasticIpRequest request)
Associates one of the stack's registered Elastic IP addresses with a specified instance.
|
AttachElasticLoadBalancerResult |
attachElasticLoadBalancer(AttachElasticLoadBalancerRequest request)
Attaches an Elastic Load Balancing load balancer to a specified layer.
|
CloneStackResult |
cloneStack(CloneStackRequest request)
Creates a clone of a specified stack.
|
CreateAppResult |
createApp(CreateAppRequest request)
Creates an app for a specified stack.
|
CreateDeploymentResult |
createDeployment(CreateDeploymentRequest request)
Runs deployment or stack commands.
|
CreateInstanceResult |
createInstance(CreateInstanceRequest request)
Creates an instance in a specified stack.
|
CreateLayerResult |
createLayer(CreateLayerRequest request)
Creates a layer.
|
CreateStackResult |
createStack(CreateStackRequest request)
Creates a new stack.
|
CreateUserProfileResult |
createUserProfile(CreateUserProfileRequest request)
Creates a new user profile.
|
DeleteAppResult |
deleteApp(DeleteAppRequest request)
Deletes a specified app.
|
DeleteInstanceResult |
deleteInstance(DeleteInstanceRequest request)
Deletes a specified instance, which terminates the associated Amazon EC2 instance.
|
DeleteLayerResult |
deleteLayer(DeleteLayerRequest request)
Deletes a specified layer.
|
DeleteStackResult |
deleteStack(DeleteStackRequest request)
Deletes a specified stack.
|
DeleteUserProfileResult |
deleteUserProfile(DeleteUserProfileRequest request)
Deletes a user profile.
|
DeregisterEcsClusterResult |
deregisterEcsCluster(DeregisterEcsClusterRequest request)
Deregisters a specified Amazon ECS cluster from a stack.
|
DeregisterElasticIpResult |
deregisterElasticIp(DeregisterElasticIpRequest request)
Deregisters a specified Elastic IP address.
|
DeregisterInstanceResult |
deregisterInstance(DeregisterInstanceRequest request)
Deregister a registered Amazon EC2 or on-premises instance.
|
DeregisterRdsDbInstanceResult |
deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest request)
Deregisters an Amazon RDS instance.
|
DeregisterVolumeResult |
deregisterVolume(DeregisterVolumeRequest request)
Deregisters an Amazon EBS volume.
|
DescribeAgentVersionsResult |
describeAgentVersions(DescribeAgentVersionsRequest request)
Describes the available AWS OpsWorks Stacks agent versions.
|
DescribeAppsResult |
describeApps(DescribeAppsRequest request)
Requests a description of a specified set of apps.
|
DescribeCommandsResult |
describeCommands(DescribeCommandsRequest request)
Describes the results of specified commands.
|
DescribeDeploymentsResult |
describeDeployments(DescribeDeploymentsRequest request)
Requests a description of a specified set of deployments.
|
DescribeEcsClustersResult |
describeEcsClusters(DescribeEcsClustersRequest request)
Describes Amazon ECS clusters that are registered with a stack.
|
DescribeElasticIpsResult |
describeElasticIps(DescribeElasticIpsRequest request)
Describes Elastic IP
addresses.
|
DescribeElasticLoadBalancersResult |
describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest request)
Describes a stack's Elastic Load Balancing instances.
|
DescribeInstancesResult |
describeInstances(DescribeInstancesRequest request)
Requests a description of a set of instances.
|
DescribeLayersResult |
describeLayers(DescribeLayersRequest request)
Requests a description of one or more layers in a specified stack.
|
DescribeLoadBasedAutoScalingResult |
describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest request)
Describes load-based auto scaling configurations for specified layers.
|
DescribeMyUserProfileResult |
describeMyUserProfile(DescribeMyUserProfileRequest request)
Describes a user's SSH information.
|
DescribePermissionsResult |
describePermissions(DescribePermissionsRequest request)
Describes the permissions for a specified stack.
|
DescribeRaidArraysResult |
describeRaidArrays(DescribeRaidArraysRequest request)
Describe an instance's RAID arrays.
|
DescribeRdsDbInstancesResult |
describeRdsDbInstances(DescribeRdsDbInstancesRequest request)
Describes Amazon RDS instances.
|
DescribeServiceErrorsResult |
describeServiceErrors(DescribeServiceErrorsRequest request)
Describes AWS OpsWorks Stacks service errors.
|
DescribeStackProvisioningParametersResult |
describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest request)
Requests a description of a stack's provisioning parameters.
|
DescribeStacksResult |
describeStacks(DescribeStacksRequest request)
Requests a description of one or more stacks.
|
DescribeStackSummaryResult |
describeStackSummary(DescribeStackSummaryRequest request)
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 . |
DescribeTimeBasedAutoScalingResult |
describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest request)
Describes time-based auto scaling configurations for specified instances.
|
DescribeUserProfilesResult |
describeUserProfiles(DescribeUserProfilesRequest request)
Describe specified users.
|
DescribeVolumesResult |
describeVolumes(DescribeVolumesRequest request)
Describes an instance's Amazon EBS volumes.
|
DetachElasticLoadBalancerResult |
detachElasticLoadBalancer(DetachElasticLoadBalancerRequest request)
Detaches a specified Elastic Load Balancing instance from its layer.
|
DisassociateElasticIpResult |
disassociateElasticIp(DisassociateElasticIpRequest request)
Disassociates an Elastic IP address from its instance.
|
ResponseMetadata |
getCachedResponseMetadata(AmazonWebServiceRequest request)
Returns additional metadata for a previously executed successful request, typically used for debugging issues
where a service isn't acting as expected.
|
GetHostnameSuggestionResult |
getHostnameSuggestion(GetHostnameSuggestionRequest request)
Gets a generated host name for the specified layer, based on the current host name theme.
|
GrantAccessResult |
grantAccess(GrantAccessRequest request)
|
ListTagsResult |
listTags(ListTagsRequest request)
Returns a list of tags that are applied to the specified stack or layer.
|
RebootInstanceResult |
rebootInstance(RebootInstanceRequest request)
Reboots a specified instance.
|
RegisterEcsClusterResult |
registerEcsCluster(RegisterEcsClusterRequest request)
Registers a specified Amazon ECS cluster with a stack.
|
RegisterElasticIpResult |
registerElasticIp(RegisterElasticIpRequest request)
Registers an Elastic IP address with a specified stack.
|
RegisterInstanceResult |
registerInstance(RegisterInstanceRequest request)
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
|
RegisterRdsDbInstanceResult |
registerRdsDbInstance(RegisterRdsDbInstanceRequest request)
Registers an Amazon RDS instance with a stack.
|
RegisterVolumeResult |
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").
|
SetLoadBasedAutoScalingResult |
setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest request)
Specify the load-based auto scaling configuration for a specified layer.
|
SetPermissionResult |
setPermission(SetPermissionRequest request)
Specifies a user's permissions.
|
void |
setRegion(Region region)
An alternative to
AWSOpsWorks.setEndpoint(String) , sets the regional endpoint for this client's service
calls. |
SetTimeBasedAutoScalingResult |
setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest request)
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.
|
StartInstanceResult |
startInstance(StartInstanceRequest request)
Starts a specified instance.
|
StartStackResult |
startStack(StartStackRequest request)
Starts a stack's instances.
|
StopInstanceResult |
stopInstance(StopInstanceRequest request)
Stops a specified instance.
|
StopStackResult |
stopStack(StopStackRequest request)
Stops a specified stack.
|
TagResourceResult |
tagResource(TagResourceRequest request)
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks.
|
UnassignInstanceResult |
unassignInstance(UnassignInstanceRequest request)
Unassigns a registered instance from all of it's layers.
|
UnassignVolumeResult |
unassignVolume(UnassignVolumeRequest request)
Unassigns an assigned Amazon EBS volume.
|
UntagResourceResult |
untagResource(UntagResourceRequest request)
Removes tags from a specified stack or layer.
|
UpdateAppResult |
updateApp(UpdateAppRequest request)
Updates a specified app.
|
UpdateElasticIpResult |
updateElasticIp(UpdateElasticIpRequest request)
Updates a registered Elastic IP address's name.
|
UpdateInstanceResult |
updateInstance(UpdateInstanceRequest request)
Updates a specified instance.
|
UpdateLayerResult |
updateLayer(UpdateLayerRequest request)
Updates a specified layer.
|
UpdateMyUserProfileResult |
updateMyUserProfile(UpdateMyUserProfileRequest request)
Updates a user's SSH public key.
|
UpdateRdsDbInstanceResult |
updateRdsDbInstance(UpdateRdsDbInstanceRequest request)
Updates an Amazon RDS instance.
|
UpdateStackResult |
updateStack(UpdateStackRequest request)
Updates a specified stack.
|
UpdateUserProfileResult |
updateUserProfile(UpdateUserProfileRequest request)
Updates a specified user profile.
|
UpdateVolumeResult |
updateVolume(UpdateVolumeRequest request)
Updates an Amazon EBS volume's name or mount point.
|
AWSOpsWorksWaiters |
waiters() |
public void setEndpoint(String endpoint)
AWSOpsWorks
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.
setEndpoint
in interface AWSOpsWorks
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.public void setRegion(Region region)
AWSOpsWorks
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.
setRegion
in interface AWSOpsWorks
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.Region.getRegion(com.amazonaws.regions.Regions)
,
Region.createClient(Class, com.amazonaws.auth.AWSCredentialsProvider, ClientConfiguration)
,
Region.isServiceSupported(String)
public AssignInstanceResult assignInstance(AssignInstanceRequest request)
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 Stacks.
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.
assignInstance
in interface AWSOpsWorks
public AssignVolumeResult assignVolume(AssignVolumeRequest request)
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.
assignVolume
in interface AWSOpsWorks
public AssociateElasticIpResult associateElasticIp(AssociateElasticIpRequest request)
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.
associateElasticIp
in interface AWSOpsWorks
public AttachElasticLoadBalancerResult attachElasticLoadBalancer(AttachElasticLoadBalancerRequest request)
AWSOpsWorks
Attaches an Elastic Load Balancing load balancer to a specified layer. AWS OpsWorks Stacks does not support Application Load Balancer. You can only use Classic Load Balancer with AWS OpsWorks Stacks. 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.
attachElasticLoadBalancer
in interface AWSOpsWorks
public CloneStackResult cloneStack(CloneStackRequest request)
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.
cloneStack
in interface AWSOpsWorks
public CreateAppResult createApp(CreateAppRequest request)
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.
createApp
in interface AWSOpsWorks
public CreateDeploymentResult createDeployment(CreateDeploymentRequest request)
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.
createDeployment
in interface AWSOpsWorks
public CreateInstanceResult createInstance(CreateInstanceRequest request)
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.
createInstance
in interface AWSOpsWorks
public CreateLayerResult createLayer(CreateLayerRequest request)
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.
createLayer
in interface AWSOpsWorks
public CreateStackResult createStack(CreateStackRequest request)
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.
createStack
in interface AWSOpsWorks
public CreateUserProfileResult createUserProfile(CreateUserProfileRequest request)
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.
createUserProfile
in interface AWSOpsWorks
public DeleteAppResult deleteApp(DeleteAppRequest request)
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.
deleteApp
in interface AWSOpsWorks
public DeleteInstanceResult deleteInstance(DeleteInstanceRequest request)
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.
deleteInstance
in interface AWSOpsWorks
public DeleteLayerResult deleteLayer(DeleteLayerRequest request)
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.
deleteLayer
in interface AWSOpsWorks
public DeleteStackResult deleteStack(DeleteStackRequest request)
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.
deleteStack
in interface AWSOpsWorks
public DeleteUserProfileResult deleteUserProfile(DeleteUserProfileRequest request)
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.
deleteUserProfile
in interface AWSOpsWorks
public DeregisterEcsClusterResult deregisterEcsCluster(DeregisterEcsClusterRequest request)
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 http://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.
deregisterEcsCluster
in interface AWSOpsWorks
public DeregisterElasticIpResult deregisterElasticIp(DeregisterElasticIpRequest request)
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.
deregisterElasticIp
in interface AWSOpsWorks
public DeregisterInstanceResult deregisterInstance(DeregisterInstanceRequest request)
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 Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
deregisterInstance
in interface AWSOpsWorks
public DeregisterRdsDbInstanceResult deregisterRdsDbInstance(DeregisterRdsDbInstanceRequest request)
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.
deregisterRdsDbInstance
in interface AWSOpsWorks
public DeregisterVolumeResult deregisterVolume(DeregisterVolumeRequest request)
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.
deregisterVolume
in interface AWSOpsWorks
public DescribeAgentVersionsResult describeAgentVersions(DescribeAgentVersionsRequest request)
AWSOpsWorks
Describes the available AWS OpsWorks Stacks agent versions. You must specify a stack ID or a configuration
manager. DescribeAgentVersions
returns a list of available agent versions for the specified stack or
configuration manager.
describeAgentVersions
in interface AWSOpsWorks
public DescribeAppsResult describeApps(DescribeAppsRequest request)
AWSOpsWorks
Requests a description of a specified set of apps.
This call accepts only one resource-identifying parameter.
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.
describeApps
in interface AWSOpsWorks
public DescribeCommandsResult describeCommands(DescribeCommandsRequest request)
AWSOpsWorks
Describes the results of specified commands.
This call accepts only one resource-identifying parameter.
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.
describeCommands
in interface AWSOpsWorks
public DescribeDeploymentsResult describeDeployments(DescribeDeploymentsRequest request)
AWSOpsWorks
Requests a description of a specified set of deployments.
This call accepts only one resource-identifying parameter.
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.
describeDeployments
in interface AWSOpsWorks
public DescribeEcsClustersResult describeEcsClusters(DescribeEcsClustersRequest request)
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
Stacks currently supports only one cluster per layer, so the result set has a maximum of one element.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permission. For more information on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeEcsClusters
in interface AWSOpsWorks
public DescribeElasticIpsResult describeElasticIps(DescribeElasticIpsRequest request)
AWSOpsWorks
Describes Elastic IP addresses.
This call accepts only one resource-identifying parameter.
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.
describeElasticIps
in interface AWSOpsWorks
public DescribeElasticLoadBalancersResult describeElasticLoadBalancers(DescribeElasticLoadBalancersRequest request)
AWSOpsWorks
Describes a stack's Elastic Load Balancing instances.
This call accepts only one resource-identifying parameter.
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.
describeElasticLoadBalancers
in interface AWSOpsWorks
public DescribeInstancesResult describeInstances(DescribeInstancesRequest request)
AWSOpsWorks
Requests a description of a set of instances.
This call accepts only one resource-identifying parameter.
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.
describeInstances
in interface AWSOpsWorks
public DescribeLayersResult describeLayers(DescribeLayersRequest request)
AWSOpsWorks
Requests a description of one or more layers in a specified stack.
This call accepts only one resource-identifying parameter.
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.
describeLayers
in interface AWSOpsWorks
public DescribeLoadBasedAutoScalingResult describeLoadBasedAutoScaling(DescribeLoadBasedAutoScalingRequest request)
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.
describeLoadBasedAutoScaling
in interface AWSOpsWorks
public DescribeMyUserProfileResult describeMyUserProfile(DescribeMyUserProfileRequest request)
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.
describeMyUserProfile
in interface AWSOpsWorks
public DescribePermissionsResult describePermissions(DescribePermissionsRequest request)
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.
describePermissions
in interface AWSOpsWorks
public DescribeRaidArraysResult describeRaidArrays(DescribeRaidArraysRequest request)
AWSOpsWorks
Describe an instance's RAID arrays.
This call accepts only one resource-identifying parameter.
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.
describeRaidArrays
in interface AWSOpsWorks
public DescribeRdsDbInstancesResult describeRdsDbInstances(DescribeRdsDbInstancesRequest request)
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.
This call accepts only one resource-identifying parameter.
describeRdsDbInstances
in interface AWSOpsWorks
public DescribeServiceErrorsResult describeServiceErrors(DescribeServiceErrorsRequest request)
AWSOpsWorks
Describes AWS OpsWorks Stacks service errors.
Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
This call accepts only one resource-identifying parameter.
describeServiceErrors
in interface AWSOpsWorks
public DescribeStackProvisioningParametersResult describeStackProvisioningParameters(DescribeStackProvisioningParametersRequest request)
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.
describeStackProvisioningParameters
in interface AWSOpsWorks
public DescribeStackSummaryResult describeStackSummary(DescribeStackSummaryRequest request)
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.
describeStackSummary
in interface AWSOpsWorks
public DescribeStacksResult describeStacks(DescribeStacksRequest request)
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.
describeStacks
in interface AWSOpsWorks
public DescribeTimeBasedAutoScalingResult describeTimeBasedAutoScaling(DescribeTimeBasedAutoScalingRequest request)
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.
describeTimeBasedAutoScaling
in interface AWSOpsWorks
public DescribeUserProfilesResult describeUserProfiles(DescribeUserProfilesRequest request)
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.
describeUserProfiles
in interface AWSOpsWorks
public DescribeVolumesResult describeVolumes(DescribeVolumesRequest request)
AWSOpsWorks
Describes an instance's Amazon EBS volumes.
This call accepts only one resource-identifying parameter.
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.
describeVolumes
in interface AWSOpsWorks
public DetachElasticLoadBalancerResult detachElasticLoadBalancer(DetachElasticLoadBalancerRequest request)
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.
detachElasticLoadBalancer
in interface AWSOpsWorks
public DisassociateElasticIpResult disassociateElasticIp(DisassociateElasticIpRequest request)
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.
disassociateElasticIp
in interface AWSOpsWorks
public GetHostnameSuggestionResult getHostnameSuggestion(GetHostnameSuggestionRequest request)
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.
getHostnameSuggestion
in interface AWSOpsWorks
public GrantAccessResult grantAccess(GrantAccessRequest request)
AWSOpsWorks
This action can be used only with Windows stacks.
Grants RDP access to a Windows instance for a specified time period.
grantAccess
in interface AWSOpsWorks
public ListTagsResult listTags(ListTagsRequest request)
AWSOpsWorks
Returns a list of tags that are applied to the specified stack or layer.
listTags
in interface AWSOpsWorks
public RebootInstanceResult rebootInstance(RebootInstanceRequest request)
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.
rebootInstance
in interface AWSOpsWorks
public RegisterEcsClusterResult registerEcsCluster(RegisterEcsClusterRequest request)
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.
registerEcsCluster
in interface AWSOpsWorks
public RegisterElasticIpResult registerElasticIp(RegisterElasticIpRequest request)
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.
registerElasticIp
in interface AWSOpsWorks
public RegisterInstanceResult registerInstance(RegisterInstanceRequest request)
AWSOpsWorks
Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.
We do not recommend using this action to register instances. The complete registration operation includes two
tasks: installing the AWS OpsWorks Stacks agent on the instance, and registering the instance with the stack.
RegisterInstance
handles only the second step. You should instead use the AWS CLI
register
command, which performs the entire registration operation. For more information, see Registering an
Instance with an AWS OpsWorks Stacks Stack.
Registered instances have the same requirements as instances that are created by using the CreateInstance API. For example, registered instances must be running a supported Linux-based operating system, and they must have a supported instance type. For more information about requirements for instances that you want to register, see Preparing the Instance.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
registerInstance
in interface AWSOpsWorks
public RegisterRdsDbInstanceResult registerRdsDbInstance(RegisterRdsDbInstanceRequest request)
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.
registerRdsDbInstance
in interface AWSOpsWorks
public RegisterVolumeResult registerVolume(RegisterVolumeRequest request)
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.
registerVolume
in interface AWSOpsWorks
public SetLoadBasedAutoScalingResult setLoadBasedAutoScaling(SetLoadBasedAutoScalingRequest request)
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.
setLoadBasedAutoScaling
in interface AWSOpsWorks
public SetPermissionResult setPermission(SetPermissionRequest request)
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.
setPermission
in interface AWSOpsWorks
public SetTimeBasedAutoScalingResult setTimeBasedAutoScaling(SetTimeBasedAutoScalingRequest request)
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.
setTimeBasedAutoScaling
in interface AWSOpsWorks
public StartInstanceResult startInstance(StartInstanceRequest request)
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.
startInstance
in interface AWSOpsWorks
public StartStackResult startStack(StartStackRequest request)
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.
startStack
in interface AWSOpsWorks
public StopInstanceResult stopInstance(StopInstanceRequest request)
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.
stopInstance
in interface AWSOpsWorks
public StopStackResult stopStack(StopStackRequest request)
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.
stopStack
in interface AWSOpsWorks
public TagResourceResult tagResource(TagResourceRequest request)
AWSOpsWorks
Apply cost-allocation tags to a specified stack or layer in AWS OpsWorks Stacks. For more information about how tagging works, see Tags in the AWS OpsWorks User Guide.
tagResource
in interface AWSOpsWorks
public UnassignInstanceResult unassignInstance(UnassignInstanceRequest request)
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 Stacks.
Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.
unassignInstance
in interface AWSOpsWorks
public UnassignVolumeResult unassignVolume(UnassignVolumeRequest request)
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.
unassignVolume
in interface AWSOpsWorks
public UntagResourceResult untagResource(UntagResourceRequest request)
AWSOpsWorks
Removes tags from a specified stack or layer.
untagResource
in interface AWSOpsWorks
public UpdateAppResult updateApp(UpdateAppRequest request)
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.
updateApp
in interface AWSOpsWorks
public UpdateElasticIpResult updateElasticIp(UpdateElasticIpRequest request)
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.
updateElasticIp
in interface AWSOpsWorks
public UpdateInstanceResult updateInstance(UpdateInstanceRequest request)
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.
updateInstance
in interface AWSOpsWorks
public UpdateLayerResult updateLayer(UpdateLayerRequest request)
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.
updateLayer
in interface AWSOpsWorks
public UpdateMyUserProfileResult updateMyUserProfile(UpdateMyUserProfileRequest request)
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.
updateMyUserProfile
in interface AWSOpsWorks
public UpdateRdsDbInstanceResult updateRdsDbInstance(UpdateRdsDbInstanceRequest request)
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.
updateRdsDbInstance
in interface AWSOpsWorks
public UpdateStackResult updateStack(UpdateStackRequest request)
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.
updateStack
in interface AWSOpsWorks
public UpdateUserProfileResult updateUserProfile(UpdateUserProfileRequest request)
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.
updateUserProfile
in interface AWSOpsWorks
public UpdateVolumeResult updateVolume(UpdateVolumeRequest request)
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.
updateVolume
in interface AWSOpsWorks
public void shutdown()
AWSOpsWorks
shutdown
in interface AWSOpsWorks
public ResponseMetadata getCachedResponseMetadata(AmazonWebServiceRequest request)
AWSOpsWorks
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.
getCachedResponseMetadata
in interface AWSOpsWorks
request
- The originally executed request.public AWSOpsWorksWaiters waiters()
waiters
in interface AWSOpsWorks
Copyright © 2013 Amazon Web Services, Inc. All Rights Reserved.