opsworks/aws.sdk.kotlin.services.opsworks

Package-level declarations

Types

Link copied to clipboard
interface OpsWorksClient : SdkClient

Welcome to the AWS OpsWorks Stacks API Reference. This guide provides descriptions, syntax, and usage examples for AWS OpsWorks Stacks actions and data types, including common parameters and error codes.

Properties

Link copied to clipboard
const val SdkVersion: String
Link copied to clipboard
Link copied to clipboard
const val ServiceId: String

Functions

Link copied to clipboard
inline suspend fun OpsWorksClient.assignInstance(crossinline block: AssignInstanceRequest.Builder.() -> Unit): AssignInstanceResponse

Assign a registered instance to a layer.

Link copied to clipboard
inline suspend fun OpsWorksClient.assignVolume(crossinline block: AssignVolumeRequest.Builder.() -> Unit): AssignVolumeResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.associateElasticIp(crossinline block: AssociateElasticIpRequest.Builder.() -> Unit): AssociateElasticIpResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.attachElasticLoadBalancer(crossinline block: AttachElasticLoadBalancerRequest.Builder.() -> Unit): AttachElasticLoadBalancerResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.cloneStack(crossinline block: CloneStackRequest.Builder.() -> Unit): CloneStackResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.createApp(crossinline block: CreateAppRequest.Builder.() -> Unit): CreateAppResponse

Creates an app for a specified stack. For more information, see Creating Apps.

Link copied to clipboard
inline suspend fun OpsWorksClient.createDeployment(crossinline block: CreateDeploymentRequest.Builder.() -> Unit): CreateDeploymentResponse

Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.

Link copied to clipboard
inline suspend fun OpsWorksClient.createInstance(crossinline block: CreateInstanceRequest.Builder.() -> Unit): CreateInstanceResponse

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Link copied to clipboard
inline suspend fun OpsWorksClient.createLayer(crossinline block: CreateLayerRequest.Builder.() -> Unit): CreateLayerResponse

Creates a layer. For more information, see How to Create a Layer.

Link copied to clipboard
inline suspend fun OpsWorksClient.createStack(crossinline block: CreateStackRequest.Builder.() -> Unit): CreateStackResponse

Creates a new stack. For more information, see Create a New Stack.

Link copied to clipboard
inline suspend fun OpsWorksClient.createUserProfile(crossinline block: CreateUserProfileRequest.Builder.() -> Unit): CreateUserProfileResponse

Creates a new user profile.

Link copied to clipboard
inline suspend fun OpsWorksClient.deleteApp(crossinline block: DeleteAppRequest.Builder.() -> Unit): DeleteAppResponse

Deletes a specified app.

Link copied to clipboard
inline suspend fun OpsWorksClient.deleteInstance(crossinline block: DeleteInstanceRequest.Builder.() -> Unit): DeleteInstanceResponse

Deletes a specified instance, which terminates the associated Amazon EC2 instance. You must stop an instance before you can delete it.

Link copied to clipboard
inline suspend fun OpsWorksClient.deleteLayer(crossinline block: DeleteLayerRequest.Builder.() -> Unit): DeleteLayerResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.deleteStack(crossinline block: DeleteStackRequest.Builder.() -> Unit): DeleteStackResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.deleteUserProfile(crossinline block: DeleteUserProfileRequest.Builder.() -> Unit): DeleteUserProfileResponse

Deletes a user profile.

Link copied to clipboard
inline suspend fun OpsWorksClient.deregisterEcsCluster(crossinline block: DeregisterEcsClusterRequest.Builder.() -> Unit): DeregisterEcsClusterResponse

Deregisters a specified Amazon ECS cluster from a stack. For more information, see Resource Management.

Link copied to clipboard
inline suspend fun OpsWorksClient.deregisterElasticIp(crossinline block: DeregisterElasticIpRequest.Builder.() -> Unit): DeregisterElasticIpResponse

Deregisters a specified Elastic IP address. The address can then be registered by another stack. For more information, see Resource Management.

Link copied to clipboard
inline suspend fun OpsWorksClient.deregisterInstance(crossinline block: DeregisterInstanceRequest.Builder.() -> Unit): DeregisterInstanceResponse

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 cannot be used with instances that were created with AWS OpsWorks Stacks.

Link copied to clipboard
inline suspend fun OpsWorksClient.deregisterRdsDbInstance(crossinline block: DeregisterRdsDbInstanceRequest.Builder.() -> Unit): DeregisterRdsDbInstanceResponse

Deregisters an Amazon RDS instance.

Link copied to clipboard
inline suspend fun OpsWorksClient.deregisterVolume(crossinline block: DeregisterVolumeRequest.Builder.() -> Unit): DeregisterVolumeResponse

Deregisters an Amazon EBS volume. The volume can then be registered by another stack. For more information, see Resource Management.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeAgentVersions(crossinline block: DescribeAgentVersionsRequest.Builder.() -> Unit): DescribeAgentVersionsResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeApps(crossinline block: DescribeAppsRequest.Builder.() -> Unit): DescribeAppsResponse

Requests a description of a specified set of apps.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeCommands(crossinline block: DescribeCommandsRequest.Builder.() -> Unit): DescribeCommandsResponse

Describes the results of specified commands.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeDeployments(crossinline block: DescribeDeploymentsRequest.Builder.() -> Unit): DescribeDeploymentsResponse

Requests a description of a specified set of deployments.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeEcsClusters(crossinline block: DescribeEcsClustersRequest.Builder.() -> Unit): DescribeEcsClustersResponse

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.

Link copied to clipboard
Link copied to clipboard
inline suspend fun OpsWorksClient.describeElasticLoadBalancers(crossinline block: DescribeElasticLoadBalancersRequest.Builder.() -> Unit): DescribeElasticLoadBalancersResponse

Describes a stack's Elastic Load Balancing instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeInstances(crossinline block: DescribeInstancesRequest.Builder.() -> Unit): DescribeInstancesResponse

Requests a description of a set of instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeLayers(crossinline block: DescribeLayersRequest.Builder.() -> Unit): DescribeLayersResponse

Requests a description of one or more layers in a specified stack.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeLoadBasedAutoScaling(crossinline block: DescribeLoadBasedAutoScalingRequest.Builder.() -> Unit): DescribeLoadBasedAutoScalingResponse

Describes load-based auto scaling configurations for specified layers.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeMyUserProfile(crossinline block: DescribeMyUserProfileRequest.Builder.() -> Unit): DescribeMyUserProfileResponse

Describes a user's SSH information.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeOperatingSystems(crossinline block: DescribeOperatingSystemsRequest.Builder.() -> Unit): DescribeOperatingSystemsResponse

Describes the operating systems that are supported by AWS OpsWorks Stacks.

Link copied to clipboard
inline suspend fun OpsWorksClient.describePermissions(crossinline block: DescribePermissionsRequest.Builder.() -> Unit): DescribePermissionsResponse

Describes the permissions for a specified stack.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeRaidArrays(crossinline block: DescribeRaidArraysRequest.Builder.() -> Unit): DescribeRaidArraysResponse

Describe an instance's RAID arrays.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeRdsDbInstances(crossinline block: DescribeRdsDbInstancesRequest.Builder.() -> Unit): DescribeRdsDbInstancesResponse

Describes Amazon RDS instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeServiceErrors(crossinline block: DescribeServiceErrorsRequest.Builder.() -> Unit): DescribeServiceErrorsResponse

Describes AWS OpsWorks Stacks service errors.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeStackProvisioningParameters(crossinline block: DescribeStackProvisioningParametersRequest.Builder.() -> Unit): DescribeStackProvisioningParametersResponse

Requests a description of a stack's provisioning parameters.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeStacks(crossinline block: DescribeStacksRequest.Builder.() -> Unit): DescribeStacksResponse

Requests a description of one or more stacks.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeStackSummary(crossinline block: DescribeStackSummaryRequest.Builder.() -> Unit): DescribeStackSummaryResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeTimeBasedAutoScaling(crossinline block: DescribeTimeBasedAutoScalingRequest.Builder.() -> Unit): DescribeTimeBasedAutoScalingResponse

Describes time-based auto scaling configurations for specified instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeUserProfiles(crossinline block: DescribeUserProfilesRequest.Builder.() -> Unit): DescribeUserProfilesResponse

Describe specified users.

Link copied to clipboard
inline suspend fun OpsWorksClient.describeVolumes(crossinline block: DescribeVolumesRequest.Builder.() -> Unit): DescribeVolumesResponse

Describes an instance's Amazon EBS volumes.

Link copied to clipboard
inline suspend fun OpsWorksClient.detachElasticLoadBalancer(crossinline block: DetachElasticLoadBalancerRequest.Builder.() -> Unit): DetachElasticLoadBalancerResponse

Detaches a specified Elastic Load Balancing instance from its layer.

Link copied to clipboard
inline suspend fun OpsWorksClient.disassociateElasticIp(crossinline block: DisassociateElasticIpRequest.Builder.() -> Unit): DisassociateElasticIpResponse

Disassociates an Elastic IP address from its instance. The address remains registered with the stack. For more information, see Resource Management.

Link copied to clipboard
inline suspend fun OpsWorksClient.getHostnameSuggestion(crossinline block: GetHostnameSuggestionRequest.Builder.() -> Unit): GetHostnameSuggestionResponse

Gets a generated host name for the specified layer, based on the current host name theme.

Link copied to clipboard
inline suspend fun OpsWorksClient.grantAccess(crossinline block: GrantAccessRequest.Builder.() -> Unit): GrantAccessResponse

This action can be used only with Windows stacks.

Link copied to clipboard
inline suspend fun OpsWorksClient.listTags(crossinline block: ListTagsRequest.Builder.() -> Unit): ListTagsResponse

Returns a list of tags that are applied to the specified stack or layer.

Link copied to clipboard
inline suspend fun OpsWorksClient.rebootInstance(crossinline block: RebootInstanceRequest.Builder.() -> Unit): RebootInstanceResponse

Reboots a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.registerEcsCluster(crossinline block: RegisterEcsClusterRequest.Builder.() -> Unit): RegisterEcsClusterResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.registerElasticIp(crossinline block: RegisterElasticIpRequest.Builder.() -> Unit): RegisterElasticIpResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.registerInstance(crossinline block: RegisterInstanceRequest.Builder.() -> Unit): RegisterInstanceResponse

Registers instances that were created outside of AWS OpsWorks Stacks with a specified stack.

Link copied to clipboard
inline suspend fun OpsWorksClient.registerRdsDbInstance(crossinline block: RegisterRdsDbInstanceRequest.Builder.() -> Unit): RegisterRdsDbInstanceResponse

Registers an Amazon RDS instance with a stack.

Link copied to clipboard
inline suspend fun OpsWorksClient.registerVolume(crossinline block: RegisterVolumeRequest.Builder.() -> Unit): RegisterVolumeResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.setLoadBasedAutoScaling(crossinline block: SetLoadBasedAutoScalingRequest.Builder.() -> Unit): SetLoadBasedAutoScalingResponse

Specify the load-based auto scaling configuration for a specified layer. For more information, see Managing Load with Time-based and Load-based Instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.setPermission(crossinline block: SetPermissionRequest.Builder.() -> Unit): SetPermissionResponse

Specifies a user's permissions. For more information, see Security and Permissions.

Link copied to clipboard
inline suspend fun OpsWorksClient.setTimeBasedAutoScaling(crossinline block: SetTimeBasedAutoScalingRequest.Builder.() -> Unit): SetTimeBasedAutoScalingResponse

Specify the time-based auto scaling configuration for a specified instance. For more information, see Managing Load with Time-based and Load-based Instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.startInstance(crossinline block: StartInstanceRequest.Builder.() -> Unit): StartInstanceResponse

Starts a specified instance. For more information, see Starting, Stopping, and Rebooting Instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.startStack(crossinline block: StartStackRequest.Builder.() -> Unit): StartStackResponse

Starts a stack's instances.

Link copied to clipboard
inline suspend fun OpsWorksClient.stopInstance(crossinline block: StopInstanceRequest.Builder.() -> Unit): StopInstanceResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.stopStack(crossinline block: StopStackRequest.Builder.() -> Unit): StopStackResponse

Stops a specified stack.

Link copied to clipboard
inline suspend fun OpsWorksClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

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.

Link copied to clipboard
inline suspend fun OpsWorksClient.unassignInstance(crossinline block: UnassignInstanceRequest.Builder.() -> Unit): UnassignInstanceResponse

Unassigns a registered instance from all layers that are using the instance. The instance remains in the stack as an unassigned instance, and can be assigned to another layer as needed. You cannot use this action with instances that were created with AWS OpsWorks Stacks.

Link copied to clipboard
inline suspend fun OpsWorksClient.unassignVolume(crossinline block: UnassignVolumeRequest.Builder.() -> Unit): UnassignVolumeResponse

Unassigns an assigned Amazon EBS volume. The volume remains registered with the stack. For more information, see Resource Management.

Link copied to clipboard
inline suspend fun OpsWorksClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes tags from a specified stack or layer.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateApp(crossinline block: UpdateAppRequest.Builder.() -> Unit): UpdateAppResponse

Updates a specified app.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateElasticIp(crossinline block: UpdateElasticIpRequest.Builder.() -> Unit): UpdateElasticIpResponse

Updates a registered Elastic IP address's name. For more information, see Resource Management.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateInstance(crossinline block: UpdateInstanceRequest.Builder.() -> Unit): UpdateInstanceResponse

Updates a specified instance.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateLayer(crossinline block: UpdateLayerRequest.Builder.() -> Unit): UpdateLayerResponse

Updates a specified layer.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateMyUserProfile(crossinline block: UpdateMyUserProfileRequest.Builder.() -> Unit): UpdateMyUserProfileResponse

Updates a user's SSH public key.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateRdsDbInstance(crossinline block: UpdateRdsDbInstanceRequest.Builder.() -> Unit): UpdateRdsDbInstanceResponse

Updates an Amazon RDS instance.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateStack(crossinline block: UpdateStackRequest.Builder.() -> Unit): UpdateStackResponse

Updates a specified stack.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateUserProfile(crossinline block: UpdateUserProfileRequest.Builder.() -> Unit): UpdateUserProfileResponse

Updates a specified user profile.

Link copied to clipboard
inline suspend fun OpsWorksClient.updateVolume(crossinline block: UpdateVolumeRequest.Builder.() -> Unit): UpdateVolumeResponse

Updates an Amazon EBS volume's name or mount point. For more information, see Resource Management.

Link copied to clipboard
fun OpsWorksClient.withConfig(block: OpsWorksClient.Config.Builder.() -> Unit): OpsWorksClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.