OpsWorks

public struct OpsWorks

Client object for interacting with AWS OpsWorks service.

AWS OpsWorks 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. AWS OpsWorks Stacks is an application management service that provides an integrated experience for overseeing the complete application lifecycle. For information about this product, go to the AWS OpsWorks details page. SDKs and CLI The most common way to use the AWS OpsWorks Stacks API is by using the AWS Command Line Interface (CLI) or by using one of the AWS SDKs to implement applications in your preferred language. For more information, see: AWS CLI AWS SDK for Java AWS SDK for .NET AWS SDK for PHP 2 AWS SDK for Ruby AWS SDK for Node.js AWS SDK for Python(Boto) Endpoints AWS OpsWorks Stacks supports the following endpoints, all HTTPS. You must connect to one of the following endpoints. Stacks can only be accessed or managed within the endpoint in which they are created. opsworks.us-east-1.amazonaws.com opsworks.us-east-2.amazonaws.com opsworks.us-west-1.amazonaws.com opsworks.us-west-2.amazonaws.com opsworks.ca-central-1.amazonaws.com (API only; not available in the AWS console) opsworks.eu-west-1.amazonaws.com opsworks.eu-west-2.amazonaws.com opsworks.eu-west-3.amazonaws.com opsworks.eu-central-1.amazonaws.com opsworks.ap-northeast-1.amazonaws.com opsworks.ap-northeast-2.amazonaws.com opsworks.ap-south-1.amazonaws.com opsworks.ap-southeast-1.amazonaws.com opsworks.ap-southeast-2.amazonaws.com opsworks.sa-east-1.amazonaws.com Chef Versions When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended and default value for Linux stacks is currently 12. Windows stacks use Chef 12.2. For more information, see Chef Versions. You can specify Chef 12, 11.10, or 11.4 for your Linux stack. We recommend migrating your existing Linux stacks to Chef 12 as soon as possible.

Member variables

Initialization

  • Initialize the OpsWorks client

    Declaration

    Swift

    public init(accessKeyId: String? = nil, secretAccessKey: String? = nil, sessionToken: String? = nil, region: AWSSDKSwiftCore.Region? = nil, endpoint: String? = nil, middlewares: [AWSServiceMiddleware] = [], eventLoopGroupProvider: AWSClient.EventLoopGroupProvider = .useAWSClientShared)

    Parameters

    accessKeyId

    Public access key provided by AWS
    secretAccessKey

    Private access key provided by AWS
    sessionToken

    Token provided by STS.AssumeRole() which allows access to another AWS account
    region

    Region of server you want to communicate with
    endpoint

    Custom endpoint URL to use instead of standard AWS servers
    middlewares

    Array of middlewares to apply to requests and responses
    eventLoopGroupProvider

    EventLoopGroup to use. Use useAWSClientShared if the client shall manage its own EventLoopGroup.

API Calls

  • 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.

    Declaration

    Swift

    @discardableResult
public func assignInstance(_ input: AssignInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func assignVolume(_ input: AssignVolumeRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func associateElasticIp(_ input: AssociateElasticIpRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func attachElasticLoadBalancer(_ input: AttachElasticLoadBalancerRequest) -> EventLoopFuture<Void>

  • Creates a clone of a specified stack. For more information, see Clone a Stack. By default, all parameters are set to the values used by the parent stack. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func cloneStack(_ input: CloneStackRequest) -> EventLoopFuture<CloneStackResult>

  • 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.

    Declaration

    Swift

    public func createApp(_ input: CreateAppRequest) -> EventLoopFuture<CreateAppResult>

  • 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.

    Declaration

    Swift

    public func createDeployment(_ input: CreateDeploymentRequest) -> EventLoopFuture<CreateDeploymentResult>

  • 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.

    Declaration

    Swift

    public func createInstance(_ input: CreateInstanceRequest) -> EventLoopFuture<CreateInstanceResult>

  • 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.

    Declaration

    Swift

    public func createLayer(_ input: CreateLayerRequest) -> EventLoopFuture<CreateLayerResult>

  • Creates a new stack. For more information, see Create a New Stack. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func createStack(_ input: CreateStackRequest) -> EventLoopFuture<CreateStackResult>

  • Creates a new user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func createUserProfile(_ input: CreateUserProfileRequest) -> EventLoopFuture<CreateUserProfileResult>

  • 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.

    Declaration

    Swift

    @discardableResult
public func deleteApp(_ input: DeleteAppRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func deleteInstance(_ input: DeleteInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func deleteLayer(_ input: DeleteLayerRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func deleteStack(_ input: DeleteStackRequest) -> EventLoopFuture<Void>

  • Deletes a user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    @discardableResult
public func deleteUserProfile(_ input: DeleteUserProfileRequest) -> EventLoopFuture<Void>

  • 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 https://docs.aws.amazon.com/opsworks/latest/userguide/opsworks-security-users.html.

    Declaration

    Swift

    @discardableResult
public func deregisterEcsCluster(_ input: DeregisterEcsClusterRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func deregisterElasticIp(_ input: DeregisterElasticIpRequest) -> EventLoopFuture<Void>

  • 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. 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.

    Declaration

    Swift

    @discardableResult
public func deregisterInstance(_ input: DeregisterInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func deregisterRdsDbInstance(_ input: DeregisterRdsDbInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func deregisterVolume(_ input: DeregisterVolumeRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func describeAgentVersions(_ input: DescribeAgentVersionsRequest) -> EventLoopFuture<DescribeAgentVersionsResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeApps(_ input: DescribeAppsRequest) -> EventLoopFuture<DescribeAppsResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeCommands(_ input: DescribeCommandsRequest) -> EventLoopFuture<DescribeCommandsResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeDeployments(_ input: DescribeDeploymentsRequest) -> EventLoopFuture<DescribeDeploymentsResult>

  • 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 about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter.

    Declaration

    Swift

    public func describeEcsClusters(_ input: DescribeEcsClustersRequest) -> EventLoopFuture<DescribeEcsClustersResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeElasticIps(_ input: DescribeElasticIpsRequest) -> EventLoopFuture<DescribeElasticIpsResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeElasticLoadBalancers(_ input: DescribeElasticLoadBalancersRequest) -> EventLoopFuture<DescribeElasticLoadBalancersResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeInstances(_ input: DescribeInstancesRequest) -> EventLoopFuture<DescribeInstancesResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeLayers(_ input: DescribeLayersRequest) -> EventLoopFuture<DescribeLayersResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeLoadBasedAutoScaling(_ input: DescribeLoadBasedAutoScalingRequest) -> EventLoopFuture<DescribeLoadBasedAutoScalingResult>

  • Describes a user’s SSH information. Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeMyUserProfile() -> EventLoopFuture<DescribeMyUserProfileResult>

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

    Declaration

    Swift

    public func describeOperatingSystems() -> EventLoopFuture<DescribeOperatingSystemsResponse>

  • 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.

    Declaration

    Swift

    public func describePermissions(_ input: DescribePermissionsRequest) -> EventLoopFuture<DescribePermissionsResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeRaidArrays(_ input: DescribeRaidArraysRequest) -> EventLoopFuture<DescribeRaidArraysResult>

  • Describes Amazon RDS instances. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter.

    Declaration

    Swift

    public func describeRdsDbInstances(_ input: DescribeRdsDbInstancesRequest) -> EventLoopFuture<DescribeRdsDbInstancesResult>

  • 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 about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter.

    Declaration

    Swift

    public func describeServiceErrors(_ input: DescribeServiceErrorsRequest) -> EventLoopFuture<DescribeServiceErrorsResult>

  • Requests a description of a stack’s provisioning parameters. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeStackProvisioningParameters(_ input: DescribeStackProvisioningParametersRequest) -> EventLoopFuture<DescribeStackProvisioningParametersResult>

  • Describes the number of layers and apps in a specified stack, and the number of instances in each state, such as running_setup or online. Required Permissions: To use this action, an IAM user must have a Show, Deploy, or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeStackSummary(_ input: DescribeStackSummaryRequest) -> EventLoopFuture<DescribeStackSummaryResult>

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

    Declaration

    Swift

    public func describeStacks(_ input: DescribeStacksRequest) -> EventLoopFuture<DescribeStacksResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeTimeBasedAutoScaling(_ input: DescribeTimeBasedAutoScalingRequest) -> EventLoopFuture<DescribeTimeBasedAutoScalingResult>

  • Describe specified users. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeUserProfiles(_ input: DescribeUserProfilesRequest) -> EventLoopFuture<DescribeUserProfilesResult>

  • 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 about user permissions, see Managing User Permissions.

    Declaration

    Swift

    public func describeVolumes(_ input: DescribeVolumesRequest) -> EventLoopFuture<DescribeVolumesResult>

  • 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.

    Declaration

    Swift

    @discardableResult
public func detachElasticLoadBalancer(_ input: DetachElasticLoadBalancerRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func disassociateElasticIp(_ input: DisassociateElasticIpRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func getHostnameSuggestion(_ input: GetHostnameSuggestionRequest) -> EventLoopFuture<GetHostnameSuggestionResult>

  • This action can be used only with Windows stacks. Grants RDP access to a Windows instance for a specified time period.

    Declaration

    Swift

    public func grantAccess(_ input: GrantAccessRequest) -> EventLoopFuture<GrantAccessResult>

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

    Declaration

    Swift

    public func listTags(_ input: ListTagsRequest) -> EventLoopFuture<ListTagsResult>

  • 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.

    Declaration

    Swift

    @discardableResult
public func rebootInstance(_ input: RebootInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func registerEcsCluster(_ input: RegisterEcsClusterRequest) -> EventLoopFuture<RegisterEcsClusterResult>

  • 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.

    Declaration

    Swift

    public func registerElasticIp(_ input: RegisterElasticIpRequest) -> EventLoopFuture<RegisterElasticIpResult>

  • 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.

    Declaration

    Swift

    public func registerInstance(_ input: RegisterInstanceRequest) -> EventLoopFuture<RegisterInstanceResult>

  • 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.

    Declaration

    Swift

    @discardableResult
public func registerRdsDbInstance(_ input: RegisterRdsDbInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    public func registerVolume(_ input: RegisterVolumeRequest) -> EventLoopFuture<RegisterVolumeResult>

  • 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.

    Declaration

    Swift

    @discardableResult
public func setLoadBasedAutoScaling(_ input: SetLoadBasedAutoScalingRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func setPermission(_ input: SetPermissionRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func setTimeBasedAutoScaling(_ input: SetTimeBasedAutoScalingRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func startInstance(_ input: StartInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func startStack(_ input: StartStackRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func stopInstance(_ input: StopInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func stopStack(_ input: StopStackRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func tagResource(_ input: TagResourceRequest) -> EventLoopFuture<Void>

  • 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. Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    @discardableResult
public func unassignInstance(_ input: UnassignInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func unassignVolume(_ input: UnassignVolumeRequest) -> EventLoopFuture<Void>

  • Removes tags from a specified stack or layer.

    Declaration

    Swift

    @discardableResult
public func untagResource(_ input: UntagResourceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func updateApp(_ input: UpdateAppRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func updateElasticIp(_ input: UpdateElasticIpRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func updateInstance(_ input: UpdateInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func updateLayer(_ input: UpdateLayerRequest) -> EventLoopFuture<Void>

  • Updates a user’s SSH public key. Required Permissions: To use this action, an IAM user must have self-management enabled or an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    @discardableResult
public func updateMyUserProfile(_ input: UpdateMyUserProfileRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func updateRdsDbInstance(_ input: UpdateRdsDbInstanceRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func updateStack(_ input: UpdateStackRequest) -> EventLoopFuture<Void>

  • Updates a specified user profile. Required Permissions: To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions.

    Declaration

    Swift

    @discardableResult
public func updateUserProfile(_ input: UpdateUserProfileRequest) -> EventLoopFuture<Void>

  • 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.

    Declaration

    Swift

    @discardableResult
public func updateVolume(_ input: UpdateVolumeRequest) -> EventLoopFuture<Void>

Paginators

  • 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 about user permissions, see Managing User Permissions. This call accepts only one resource-identifying parameter.

    Declaration

    Swift

    public func describeEcsClustersPaginator(_ input: DescribeEcsClustersRequest, onPage: @escaping (DescribeEcsClustersResult, EventLoop) -> EventLoopFuture<Bool>) -> EventLoopFuture<Void>

Shapes

Enums

  • Undocumented

    See more

    Declaration

    Swift

    public enum AppAttributesKeys : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum AppType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum Architecture : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum AutoScalingType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum CloudWatchLogsEncoding : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum CloudWatchLogsInitialPosition : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum CloudWatchLogsTimeZone : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum DeploymentCommandName : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LayerAttributesKeys : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum LayerType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum RootDeviceType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum SourceType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum StackAttributesKeys : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum VirtualizationType : String, CustomStringConvertible, Codable

  • Undocumented

    See more

    Declaration

    Swift

    public enum VolumeType : String, CustomStringConvertible, Codable