GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  PAWS::OPSWORKS (3)

.ds Aq ’

NAME

Paws::OpsWorks - Perl Interface to AWS AWS OpsWorks

CONTENTS

SYNOPSIS



  use Paws;

  my $obj = Paws->service(OpsWorks)->new;
  my $res = $obj->Method(
    Arg1 => $val1,
    Arg2 => [ V1, V2 ],
    # if Arg3 is an object, the HashRef will be used as arguments to the constructor
    # of the arguments type
    Arg3 => { Att1 => Val1 },
    # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
    # the constructor of the arguments type
    Arg4 => [ { Att1 => Val1  }, { Att1 => Val2 } ],
  );



DESCRIPTION

AWS OpsWorks

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

AWS OpsWorks 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.

<B>SDKs and CLIB>

The most common way to use the AWS OpsWorks 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:
o AWS CLI
o AWS SDK for Java
o AWS SDK for .NET
o AWS SDK for PHP 2
o AWS SDK for Ruby
o AWS SDK for Node.js
o AWS SDK for Python(Boto)
<B>EndpointsB>

AWS OpsWorks supports only one endpoint, opsworks.us-east-1.amazonaws.com (HTTPS), so you must connect to that endpoint. You can then use the API to direct AWS OpsWorks to create stacks in any AWS Region.

<B>Chef VersionsB>

When you call CreateStack, CloneStack, or UpdateStack we recommend you use the ConfigurationManager parameter to specify the Chef version. The recommended value for Linux stacks, which is also the default value, is currently 11.10. Windows stacks use Chef 12.2. For more information, see Chef Versions.

You can also specify Chef 11.4 or Chef 0.9 for your Linux stack. However, Chef 0.9 has been deprecated. We do not recommend using Chef 0.9 for new stacks, and we recommend migrating your existing Chef 0.9 stacks to Chef 11.10 as soon as possible.

METHODS

    AssignInstance(InstanceId => Str, LayerIds => ArrayRef[Str])

Each argument is described in detail in: Paws::OpsWorks::AssignInstance

Returns: nothing

Assign a registered instance to a layer.
o You can assign registered on-premises instances to any layer type.
o You can assign registered Amazon EC2 instances only to custom layers.
o You cannot use this action with instances that were created with AWS OpsWorks.
<B>Required PermissionsB>: 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.

    AssignVolume(VolumeId => Str, [InstanceId => Str])

Each argument is described in detail in: Paws::OpsWorks::AssignVolume

Returns: nothing

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.

<B>Required PermissionsB>: 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(ElasticIp => Str, [InstanceId => Str])

Each argument is described in detail in: Paws::OpsWorks::AssociateElasticIp

Returns: nothing

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.

<B>Required PermissionsB>: 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(ElasticLoadBalancerName => Str, LayerId => Str)

Each argument is described in detail in: Paws::OpsWorks::AttachElasticLoadBalancer

Returns: nothing

Attaches an Elastic Load Balancing load balancer to a specified layer. For more information, see Elastic Load Balancing.

You must create the Elastic Load Balancing instance separately, by using the Elastic Load Balancing console, API, or CLI. For more information, see Elastic Load Balancing Developer Guide.

<B>Required PermissionsB>: 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.

    CloneStack(ServiceRoleArn => Str, SourceStackId => Str, [AgentVersion => Str, Attributes => Paws::OpsWorks::StackAttributes, ChefConfiguration => Paws::OpsWorks::ChefConfiguration, CloneAppIds => ArrayRef[Str], ClonePermissions => Bool, ConfigurationManager => Paws::OpsWorks::StackConfigurationManager, CustomCookbooksSource => Paws::OpsWorks::Source, CustomJson => Str, DefaultAvailabilityZone => Str, DefaultInstanceProfileArn => Str, DefaultOs => Str, DefaultRootDeviceType => Str, DefaultSshKeyName => Str, DefaultSubnetId => Str, HostnameTheme => Str, Name => Str, Region => Str, UseCustomCookbooks => Bool, UseOpsworksSecurityGroups => Bool, VpcId => Str])

Each argument is described in detail in: Paws::OpsWorks::CloneStack

Returns: a Paws::OpsWorks::CloneStackResult instance

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.

<B>Required PermissionsB>: 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.

    CreateApp(Name => Str, StackId => Str, Type => Str, [AppSource => Paws::OpsWorks::Source, Attributes => Paws::OpsWorks::AppAttributes, DataSources => ArrayRef[Paws::OpsWorks::DataSource], Description => Str, Domains => ArrayRef[Str], EnableSsl => Bool, Environment => ArrayRef[Paws::OpsWorks::EnvironmentVariable], Shortname => Str, SslConfiguration => Paws::OpsWorks::SslConfiguration])

Each argument is described in detail in: Paws::OpsWorks::CreateApp

Returns: a Paws::OpsWorks::CreateAppResult instance

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

<B>Required PermissionsB>: 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.

    CreateDeployment(Command => Paws::OpsWorks::DeploymentCommand, StackId => Str, [AppId => Str, Comment => Str, CustomJson => Str, InstanceIds => ArrayRef[Str]])

Each argument is described in detail in: Paws::OpsWorks::CreateDeployment

Returns: a Paws::OpsWorks::CreateDeploymentResult instance

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

<B>Required PermissionsB>: 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.

    CreateInstance(InstanceType => Str, LayerIds => ArrayRef[Str], StackId => Str, [AgentVersion => Str, AmiId => Str, Architecture => Str, AutoScalingType => Str, AvailabilityZone => Str, BlockDeviceMappings => ArrayRef[Paws::OpsWorks::BlockDeviceMapping], EbsOptimized => Bool, Hostname => Str, InstallUpdatesOnBoot => Bool, Os => Str, RootDeviceType => Str, SshKeyName => Str, SubnetId => Str, VirtualizationType => Str])

Each argument is described in detail in: Paws::OpsWorks::CreateInstance

Returns: a Paws::OpsWorks::CreateInstanceResult instance

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

<B>Required PermissionsB>: 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(Name => Str, Shortname => Str, StackId => Str, Type => Str, [Attributes => Paws::OpsWorks::LayerAttributes, AutoAssignElasticIps => Bool, AutoAssignPublicIps => Bool, CustomInstanceProfileArn => Str, CustomJson => Str, CustomRecipes => Paws::OpsWorks::Recipes, CustomSecurityGroupIds => ArrayRef[Str], EnableAutoHealing => Bool, InstallUpdatesOnBoot => Bool, LifecycleEventConfiguration => Paws::OpsWorks::LifecycleEventConfiguration, Packages => ArrayRef[Str], UseEbsOptimizedInstances => Bool, VolumeConfigurations => ArrayRef[Paws::OpsWorks::VolumeConfiguration]])

Each argument is described in detail in: Paws::OpsWorks::CreateLayer

Returns: a Paws::OpsWorks::CreateLayerResult instance

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

You should use <B>CreateLayerB> 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, <B>CreateLayerB> fails. A stack can have an arbitrary number of custom layers, so you can call <B>CreateLayerB> as many times as you like for that layer type.

<B>Required PermissionsB>: 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.

    CreateStack(DefaultInstanceProfileArn => Str, Name => Str, Region => Str, ServiceRoleArn => Str, [AgentVersion => Str, Attributes => Paws::OpsWorks::StackAttributes, ChefConfiguration => Paws::OpsWorks::ChefConfiguration, ConfigurationManager => Paws::OpsWorks::StackConfigurationManager, CustomCookbooksSource => Paws::OpsWorks::Source, CustomJson => Str, DefaultAvailabilityZone => Str, DefaultOs => Str, DefaultRootDeviceType => Str, DefaultSshKeyName => Str, DefaultSubnetId => Str, HostnameTheme => Str, UseCustomCookbooks => Bool, UseOpsworksSecurityGroups => Bool, VpcId => Str])

Each argument is described in detail in: Paws::OpsWorks::CreateStack

Returns: a Paws::OpsWorks::CreateStackResult instance

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

<B>Required PermissionsB>: 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(IamUserArn => Str, [AllowSelfManagement => Bool, SshPublicKey => Str, SshUsername => Str])

Each argument is described in detail in: Paws::OpsWorks::CreateUserProfile

Returns: a Paws::OpsWorks::CreateUserProfileResult instance

Creates a new user profile.

<B>Required PermissionsB>: 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.

    DeleteApp(AppId => Str)

Each argument is described in detail in: Paws::OpsWorks::DeleteApp

Returns: nothing

Deletes a specified app.

<B>Required PermissionsB>: 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(InstanceId => Str, [DeleteElasticIp => Bool, DeleteVolumes => Bool])

Each argument is described in detail in: Paws::OpsWorks::DeleteInstance

Returns: nothing

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.

<B>Required PermissionsB>: 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(LayerId => Str)

Each argument is described in detail in: Paws::OpsWorks::DeleteLayer

Returns: nothing

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.

<B>Required PermissionsB>: 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(StackId => Str)

Each argument is described in detail in: Paws::OpsWorks::DeleteStack

Returns: nothing

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.

<B>Required PermissionsB>: 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.

    DeleteUserProfile(IamUserArn => Str)

Each argument is described in detail in: Paws::OpsWorks::DeleteUserProfile

Returns: nothing

Deletes a user profile.

<B>Required PermissionsB>: 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.

    DeregisterEcsCluster(EcsClusterArn => Str)

Each argument is described in detail in: Paws::OpsWorks::DeregisterEcsCluster

Returns: nothing

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

<B>Required PermissionsB>: 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 .

    DeregisterElasticIp(ElasticIp => Str)

Each argument is described in detail in: Paws::OpsWorks::DeregisterElasticIp

Returns: nothing

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

<B>Required PermissionsB>: 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(InstanceId => Str)

Each argument is described in detail in: Paws::OpsWorks::DeregisterInstance

Returns: nothing

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.

<B>Required PermissionsB>: 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(RdsDbInstanceArn => Str)

Each argument is described in detail in: Paws::OpsWorks::DeregisterRdsDbInstance

Returns: nothing

Deregisters an Amazon RDS instance.

<B>Required PermissionsB>: 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(VolumeId => Str)

Each argument is described in detail in: Paws::OpsWorks::DeregisterVolume

Returns: nothing

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

<B>Required PermissionsB>: 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.

    DescribeAgentVersions([ConfigurationManager => Paws::OpsWorks::StackConfigurationManager, StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeAgentVersions

Returns: a Paws::OpsWorks::DescribeAgentVersionsResult instance

Describes the available AWS OpsWorks agent versions. You must specify a stack ID or a configuration manager. DescribeAgentVersions returns a list of available agent versions for the specified stack or configuration manager.

    DescribeApps([AppIds => ArrayRef[Str], StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeApps

Returns: a Paws::OpsWorks::DescribeAppsResult instance

Requests a description of a specified set of apps.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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([CommandIds => ArrayRef[Str], DeploymentId => Str, InstanceId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeCommands

Returns: a Paws::OpsWorks::DescribeCommandsResult instance

Describes the results of specified commands.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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([AppId => Str, DeploymentIds => ArrayRef[Str], StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeDeployments

Returns: a Paws::OpsWorks::DescribeDeploymentsResult instance

Requests a description of a specified set of deployments.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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.

    DescribeEcsClusters([EcsClusterArns => ArrayRef[Str], MaxResults => Int, NextToken => Str, StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeEcsClusters

Returns: a Paws::OpsWorks::DescribeEcsClustersResult instance

Describes Amazon ECS clusters that are registered with a stack. If you specify only a stack ID, you can use the MaxResults and NextToken parameters to paginate the response. However, AWS OpsWorks currently supports only one cluster per layer, so the result set has a maximum of one element.

<B>Required PermissionsB>: 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.

    DescribeElasticIps([InstanceId => Str, Ips => ArrayRef[Str], StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeElasticIps

Returns: a Paws::OpsWorks::DescribeElasticIpsResult instance

Describes Elastic IP addresses.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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([LayerIds => ArrayRef[Str], StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeElasticLoadBalancers

Returns: a Paws::OpsWorks::DescribeElasticLoadBalancersResult instance

Describes a stack’s Elastic Load Balancing instances.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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([InstanceIds => ArrayRef[Str], LayerId => Str, StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeInstances

Returns: a Paws::OpsWorks::DescribeInstancesResult instance

Requests a description of a set of instances.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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([LayerIds => ArrayRef[Str], StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeLayers

Returns: a Paws::OpsWorks::DescribeLayersResult instance

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

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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(LayerIds => ArrayRef[Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeLoadBasedAutoScaling

Returns: a Paws::OpsWorks::DescribeLoadBasedAutoScalingResult instance

Describes load-based auto scaling configurations for specified layers.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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.

    DescribeMyUserProfile( => )

Each argument is described in detail in: Paws::OpsWorks::DescribeMyUserProfile

Returns: a Paws::OpsWorks::DescribeMyUserProfileResult instance

Describes a user’s SSH information.

<B>Required PermissionsB>: 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.

    DescribePermissions([IamUserArn => Str, StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribePermissions

Returns: a Paws::OpsWorks::DescribePermissionsResult instance

Describes the permissions for a specified stack.

<B>Required PermissionsB>: 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.

    DescribeRaidArrays([InstanceId => Str, RaidArrayIds => ArrayRef[Str], StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeRaidArrays

Returns: a Paws::OpsWorks::DescribeRaidArraysResult instance

Describe an instance’s RAID arrays.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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.

    DescribeRdsDbInstances(StackId => Str, [RdsDbInstanceArns => ArrayRef[Str]])

Each argument is described in detail in: Paws::OpsWorks::DescribeRdsDbInstances

Returns: a Paws::OpsWorks::DescribeRdsDbInstancesResult instance

Describes Amazon RDS instances.

<B>Required PermissionsB>: 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.

    DescribeServiceErrors([InstanceId => Str, ServiceErrorIds => ArrayRef[Str], StackId => Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeServiceErrors

Returns: a Paws::OpsWorks::DescribeServiceErrorsResult instance

Describes AWS OpsWorks service errors.

<B>Required PermissionsB>: 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(StackId => Str)

Each argument is described in detail in: Paws::OpsWorks::DescribeStackProvisioningParameters

Returns: a Paws::OpsWorks::DescribeStackProvisioningParametersResult instance

Requests a description of a stack’s provisioning parameters.

<B>Required PermissionsB>: 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([StackIds => ArrayRef[Str]])

Each argument is described in detail in: Paws::OpsWorks::DescribeStacks

Returns: a Paws::OpsWorks::DescribeStacksResult instance

Requests a description of one or more stacks.

<B>Required PermissionsB>: 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(StackId => Str)

Each argument is described in detail in: Paws::OpsWorks::DescribeStackSummary

Returns: a Paws::OpsWorks::DescribeStackSummaryResult instance

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.

<B>Required PermissionsB>: 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(InstanceIds => ArrayRef[Str])

Each argument is described in detail in: Paws::OpsWorks::DescribeTimeBasedAutoScaling

Returns: a Paws::OpsWorks::DescribeTimeBasedAutoScalingResult instance

Describes time-based auto scaling configurations for specified instances.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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.

    DescribeUserProfiles([IamUserArns => ArrayRef[Str]])

Each argument is described in detail in: Paws::OpsWorks::DescribeUserProfiles

Returns: a Paws::OpsWorks::DescribeUserProfilesResult instance

Describe specified users.

<B>Required PermissionsB>: 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.

    DescribeVolumes([InstanceId => Str, RaidArrayId => Str, StackId => Str, VolumeIds => ArrayRef[Str]])

Each argument is described in detail in: Paws::OpsWorks::DescribeVolumes

Returns: a Paws::OpsWorks::DescribeVolumesResult instance

Describes an instance’s Amazon EBS volumes.

You must specify at least one of the parameters.

<B>Required PermissionsB>: 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.

    DetachElasticLoadBalancer(ElasticLoadBalancerName => Str, LayerId => Str)

Each argument is described in detail in: Paws::OpsWorks::DetachElasticLoadBalancer

Returns: nothing

Detaches a specified Elastic Load Balancing instance from its layer.

<B>Required PermissionsB>: 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(ElasticIp => Str)

Each argument is described in detail in: Paws::OpsWorks::DisassociateElasticIp

Returns: nothing

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

<B>Required PermissionsB>: 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(LayerId => Str)

Each argument is described in detail in: Paws::OpsWorks::GetHostnameSuggestion

Returns: a Paws::OpsWorks::GetHostnameSuggestionResult instance

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

<B>Required PermissionsB>: 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.

    GrantAccess(InstanceId => Str, [ValidForInMinutes => Int])

Each argument is described in detail in: Paws::OpsWorks::GrantAccess

Returns: a Paws::OpsWorks::GrantAccessResult instance

This action can be used only with Windows stacks.

Grants RDP access to a Windows instance for a specified time period.

    RebootInstance(InstanceId => Str)

Each argument is described in detail in: Paws::OpsWorks::RebootInstance

Returns: nothing

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

<B>Required PermissionsB>: 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(EcsClusterArn => Str, StackId => Str)

Each argument is described in detail in: Paws::OpsWorks::RegisterEcsCluster

Returns: a Paws::OpsWorks::RegisterEcsClusterResult instance

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.

<B>Required PermissionsB>: 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(ElasticIp => Str, StackId => Str)

Each argument is described in detail in: Paws::OpsWorks::RegisterElasticIp

Returns: a Paws::OpsWorks::RegisterElasticIpResult instance

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.

<B>Required PermissionsB>: 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(StackId => Str, [Hostname => Str, InstanceIdentity => Paws::OpsWorks::InstanceIdentity, PrivateIp => Str, PublicIp => Str, RsaPublicKey => Str, RsaPublicKeyFingerprint => Str])

Each argument is described in detail in: Paws::OpsWorks::RegisterInstance

Returns: a Paws::OpsWorks::RegisterInstanceResult instance

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

We do not recommend using this action to register instances. The complete registration operation has two primary steps, installing the AWS OpsWorks agent on the instance and registering the instance with the stack. RegisterInstance handles only the second step. You should instead use the AWS CLI register command, which performs the entire registration operation. For more information, see Registering an Instance with an AWS OpsWorks Stack.

<B>Required PermissionsB>: 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(DbPassword => Str, DbUser => Str, RdsDbInstanceArn => Str, StackId => Str)

Each argument is described in detail in: Paws::OpsWorks::RegisterRdsDbInstance

Returns: nothing

Registers an Amazon RDS instance with a stack.

<B>Required PermissionsB>: 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(StackId => Str, [Ec2VolumeId => Str])

Each argument is described in detail in: Paws::OpsWorks::RegisterVolume

Returns: a Paws::OpsWorks::RegisterVolumeResult instance

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.

<B>Required PermissionsB>: 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(LayerId => Str, [DownScaling => Paws::OpsWorks::AutoScalingThresholds, Enable => Bool, UpScaling => Paws::OpsWorks::AutoScalingThresholds])

Each argument is described in detail in: Paws::OpsWorks::SetLoadBasedAutoScaling

Returns: nothing

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.

<B>Required PermissionsB>: 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(IamUserArn => Str, StackId => Str, [AllowSsh => Bool, AllowSudo => Bool, Level => Str])

Each argument is described in detail in: Paws::OpsWorks::SetPermission

Returns: nothing

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

<B>Required PermissionsB>: 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(InstanceId => Str, [AutoScalingSchedule => Paws::OpsWorks::WeeklyAutoScalingSchedule])

Each argument is described in detail in: Paws::OpsWorks::SetTimeBasedAutoScaling

Returns: nothing

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

<B>Required PermissionsB>: 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(InstanceId => Str)

Each argument is described in detail in: Paws::OpsWorks::StartInstance

Returns: nothing

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

<B>Required PermissionsB>: 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(StackId => Str)

Each argument is described in detail in: Paws::OpsWorks::StartStack

Returns: nothing

Starts a stack’s instances.

<B>Required PermissionsB>: 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(InstanceId => Str)

Each argument is described in detail in: Paws::OpsWorks::StopInstance

Returns: nothing

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.

<B>Required PermissionsB>: 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(StackId => Str)

Each argument is described in detail in: Paws::OpsWorks::StopStack

Returns: nothing

Stops a specified stack.

<B>Required PermissionsB>: 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(InstanceId => Str)

Each argument is described in detail in: Paws::OpsWorks::UnassignInstance

Returns: nothing

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.

<B>Required PermissionsB>: 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(VolumeId => Str)

Each argument is described in detail in: Paws::OpsWorks::UnassignVolume

Returns: nothing

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

<B>Required PermissionsB>: 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.

    UpdateApp(AppId => Str, [AppSource => Paws::OpsWorks::Source, Attributes => Paws::OpsWorks::AppAttributes, DataSources => ArrayRef[Paws::OpsWorks::DataSource], Description => Str, Domains => ArrayRef[Str], EnableSsl => Bool, Environment => ArrayRef[Paws::OpsWorks::EnvironmentVariable], Name => Str, SslConfiguration => Paws::OpsWorks::SslConfiguration, Type => Str])

Each argument is described in detail in: Paws::OpsWorks::UpdateApp

Returns: nothing

Updates a specified app.

<B>Required PermissionsB>: 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.

    UpdateElasticIp(ElasticIp => Str, [Name => Str])

Each argument is described in detail in: Paws::OpsWorks::UpdateElasticIp

Returns: nothing

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

<B>Required PermissionsB>: 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(InstanceId => Str, [AgentVersion => Str, AmiId => Str, Architecture => Str, AutoScalingType => Str, EbsOptimized => Bool, Hostname => Str, InstallUpdatesOnBoot => Bool, InstanceType => Str, LayerIds => ArrayRef[Str], Os => Str, SshKeyName => Str])

Each argument is described in detail in: Paws::OpsWorks::UpdateInstance

Returns: nothing

Updates a specified instance.

<B>Required PermissionsB>: 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(LayerId => Str, [Attributes => Paws::OpsWorks::LayerAttributes, AutoAssignElasticIps => Bool, AutoAssignPublicIps => Bool, CustomInstanceProfileArn => Str, CustomJson => Str, CustomRecipes => Paws::OpsWorks::Recipes, CustomSecurityGroupIds => ArrayRef[Str], EnableAutoHealing => Bool, InstallUpdatesOnBoot => Bool, LifecycleEventConfiguration => Paws::OpsWorks::LifecycleEventConfiguration, Name => Str, Packages => ArrayRef[Str], Shortname => Str, UseEbsOptimizedInstances => Bool, VolumeConfigurations => ArrayRef[Paws::OpsWorks::VolumeConfiguration]])

Each argument is described in detail in: Paws::OpsWorks::UpdateLayer

Returns: nothing

Updates a specified layer.

<B>Required PermissionsB>: 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.

    UpdateMyUserProfile([SshPublicKey => Str])

Each argument is described in detail in: Paws::OpsWorks::UpdateMyUserProfile

Returns: nothing

Updates a user’s SSH public key.

<B>Required PermissionsB>: 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.

    UpdateRdsDbInstance(RdsDbInstanceArn => Str, [DbPassword => Str, DbUser => Str])

Each argument is described in detail in: Paws::OpsWorks::UpdateRdsDbInstance

Returns: nothing

Updates an Amazon RDS instance.

<B>Required PermissionsB>: 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(StackId => Str, [AgentVersion => Str, Attributes => Paws::OpsWorks::StackAttributes, ChefConfiguration => Paws::OpsWorks::ChefConfiguration, ConfigurationManager => Paws::OpsWorks::StackConfigurationManager, CustomCookbooksSource => Paws::OpsWorks::Source, CustomJson => Str, DefaultAvailabilityZone => Str, DefaultInstanceProfileArn => Str, DefaultOs => Str, DefaultRootDeviceType => Str, DefaultSshKeyName => Str, DefaultSubnetId => Str, HostnameTheme => Str, Name => Str, ServiceRoleArn => Str, UseCustomCookbooks => Bool, UseOpsworksSecurityGroups => Bool])

Each argument is described in detail in: Paws::OpsWorks::UpdateStack

Returns: nothing

Updates a specified stack.

<B>Required PermissionsB>: 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.

    UpdateUserProfile(IamUserArn => Str, [AllowSelfManagement => Bool, SshPublicKey => Str, SshUsername => Str])

Each argument is described in detail in: Paws::OpsWorks::UpdateUserProfile

Returns: nothing

Updates a specified user profile.

<B>Required PermissionsB>: 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.

    UpdateVolume(VolumeId => Str, [MountPoint => Str, Name => Str])

Each argument is described in detail in: Paws::OpsWorks::UpdateVolume

Returns: nothing

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

<B>Required PermissionsB>: 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.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues

Search for    or go to Top of page |  Section 3 |  Main Index


perl v5.20.3 PAWS::OPSWORKS (3) 2015-08-06

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.