Module erlcloud_as

Function Index

complete_lifecycle_action/4
complete_lifecycle_action/5
create_auto_scaling_group/2Create AutoScaling group.
create_launch_config/2Create launch configuration.
delete_auto_scaling_group/3Delete AutoScaling group.
delete_launch_configuration/2Delete launch configuration.
describe_groups/0Calls describe_groups([], default_configuration()).
describe_groups/1describe_groups with a specific configuration OR with a specific list of members.
describe_groups/2Get descriptions of the given autoscaling groups.
describe_groups/4Get descriptions of the given autoscaling groups with a given maximum number of results and optional paging offset.
describe_instances/0describe_instances([], default max results, no paging offset, default config).
describe_instances/1
describe_instances/2
describe_instances/4Get more information on the given list of instances in your autoscaling groups or all if an empty list is passed in I.
describe_launch_configs/0
describe_launch_configs/1
describe_launch_configs/2
describe_launch_configs/4Get descriptions of the given launch configurations with a given maximum number of results and optional paging offset.
describe_lifecycle_hooks/1
describe_lifecycle_hooks/2
describe_lifecycle_hooks/3
describe_scaling_activities/3Get scaling activities descriptions of the given autoscaling group with a given maximum number of results.
detach_instances/2Detach the given instances from the group using the default configuration without decrementing the desired capacity of the group.
detach_instances/3Detach the given instances from the group.
detach_instances/4
record_lifecycle_action_heartbeat/3
record_lifecycle_action_heartbeat/4
resume_processes/1Resumes Auto Scaling processes for the specified Auto Scaling group.
resume_processes/2Resume the processes.
resume_processes/3
set_desired_capacity/2set_desired_capacity(GroupName, Capacity, false, default_config()).
set_desired_capacity/3set_desired_capacity(GroupName, Capacity, false, Config).
set_desired_capacity/4Change the desired capacity of the given autoscaling group, optionally ignoring cooldown periods (set false to basically force change).
suspend_processes/1Suspends Auto Scaling processes for the specified Auto Scaling group.
suspend_processes/2Suspend the processes.
suspend_processes/3
terminate_instance/1Terminate the given instance using the default configuration without decrementing the desired capacity of the group.
terminate_instance/2Terminate the given instance.
terminate_instance/3
update_auto_scaling_group/2Update AutoScaling group.

Function Details

complete_lifecycle_action/4

complete_lifecycle_action(GroupName::string(), LifecycleActionResult::string(), LifecycleHookName::string(), InstanceIdOrLifecycleActionToken::{instance_id | token, string()}) -> {ok, string()} | {error, term()}

complete_lifecycle_action/5

complete_lifecycle_action(GroupName::string(), LifecycleActionResult::string(), LifecycleHookName::string(), InstanceIdOrLifecycleActionToken::{instance_id | token, string()}, Config::aws_config()) -> {ok, string()} | {error, term()}

create_auto_scaling_group/2

create_auto_scaling_group(Aws_autoscaling_group::aws_autoscaling_group(), Config::aws_config()) -> ok | {error, term()}

Create AutoScaling group.

create_launch_config/2

create_launch_config(Aws_launch_config::aws_launch_config(), Config::aws_config()) -> ok | {error, term()}

Create launch configuration.

delete_auto_scaling_group/3

delete_auto_scaling_group(Name::string(), ForceDelete::boolean(), Config::aws_config()) -> ok | {error, term()}

Delete AutoScaling group. ForceDelete Specifies that the group will be deleted along with all instances associated with the group, without waiting for all instances to be terminated. This parameter also deletes any lifecycle actions associated with the group.

delete_launch_configuration/2

delete_launch_configuration(Name::string(), Config::aws_config()) -> ok | {error, term()}

Delete launch configuration.

describe_groups/0

describe_groups() -> any()

Calls describe_groups([], default_configuration())

describe_groups/1

describe_groups(Config) -> any()

describe_groups with a specific configuration OR with a specific list of members.

describe_groups/2

describe_groups(GN::[string()], Config::aws_config()) -> {ok, term()} | {{paged, string()}, term()} | {error, term()}

Get descriptions of the given autoscaling groups. The account calling this function needs permission for the autoscaling:DescribeAutoScalingGroups action.

Returns {{paged, NextPageId}, Results} if there are more than the current maximum count of results, {ok, Results} if everything fits and {error, Reason} if there was a problem.

describe_groups/4

describe_groups(GN::[string()], MaxRecords::integer(), NextToken::string() | none, Config::aws_config()) -> {ok, term()} | {{paged, string()}, term()} | {error, term()}

Get descriptions of the given autoscaling groups with a given maximum number of results and optional paging offset.

describe_instances/0

describe_instances() -> any()

describe_instances([], default max results, no paging offset, default config).

describe_instances/1

describe_instances(Config) -> any()

describe_instances/2

describe_instances(I, Config) -> any()

describe_instances/4

describe_instances(I, MaxRecords, NextToken, Config) -> any()

Get more information on the given list of instances in your autoscaling groups or all if an empty list is passed in I.

describe_launch_configs/0

describe_launch_configs() -> any()

describe_launch_configs/1

describe_launch_configs(Config) -> any()

describe_launch_configs/2

describe_launch_configs(LN, Config) -> any()

describe_launch_configs/4

describe_launch_configs(LN, MaxRecords, NextToken, Config) -> any()

Get descriptions of the given launch configurations with a given maximum number of results and optional paging offset. Pass an empty list of names to get all.

describe_lifecycle_hooks/1

describe_lifecycle_hooks(GroupName) -> any()

describe_lifecycle_hooks/2

describe_lifecycle_hooks(GroupName, LifecycleHookNames) -> any()

describe_lifecycle_hooks/3

describe_lifecycle_hooks(GroupName::string(), LifecycleHookNames::[string()], Config::aws_config()) -> {ok, [aws_autoscaling_lifecycle_hook()]} | {error, term()}

describe_scaling_activities/3

describe_scaling_activities(GroupName::string(), Count::non_neg_integer(), Config::aws_config()) -> {ok, [aws_autoscaling_activity()]} | {error, term()}

Get scaling activities descriptions of the given autoscaling group with a given maximum number of results.

detach_instances/2

detach_instances(InstanceIds::[string()], GroupName::string()) -> {ok, [aws_autoscaling_activity()]} | {error, term()}

Detach the given instances from the group using the default configuration without decrementing the desired capacity of the group.

detach_instances/3

detach_instances(InstanceIds::[string()], GroupName::string(), ShouldDecrementDesiredCapacity::boolean() | aws_config()) -> {ok, [aws_autoscaling_activity()]} | {error, term()}

Detach the given instances from the group. The 3rd parameter can be: 'false' to not decrement the desired capacity of the group 'true' to decrement the desired capacity of the group Config a supplied AWS configuration.

detach_instances/4

detach_instances(InstanceIds::[string()], GroupName::string(), ShouldDecrementDesiredCapacity::boolean(), Config::aws_config()) -> {ok, [aws_autoscaling_activity()]} | {error, term()}

record_lifecycle_action_heartbeat/3

record_lifecycle_action_heartbeat(GroupName::string(), LifecycleHookName::string(), InstanceIdOrLifecycleActionToken::{instance_id | token, string()}) -> {ok, string()} | {error, term()}

record_lifecycle_action_heartbeat/4

record_lifecycle_action_heartbeat(GroupName::string(), LifecycleHookName::string(), InstanceIdOrLifecycleActionToken::{instance_id | token, string()}, Config::aws_config()) -> {ok, string()} | {error, term()}

resume_processes/1

resume_processes(GroupName::string()) -> {ok, string()} | {error, term()}

Resumes Auto Scaling processes for the specified Auto Scaling group. To resume specific processes, use the ScalingProcesses parameter. To resume all processes, omit the ScalingProcesses parameter.

resume_processes/2

resume_processes(GroupName, Config) -> any()

Resume the processes. The 2nd parameter can be used to specify a list of ScalingProcesses or [] to resume all Config a supplied AWS configuration.

resume_processes/3

resume_processes(GroupName::string(), ScalingProcesses::[string()], Config::aws_config()) -> {ok, string()} | {error, term()}

set_desired_capacity/2

set_desired_capacity(GroupName::string(), Capacity::integer()) -> {ok, string()} | {error, term()}

set_desired_capacity(GroupName, Capacity, false, default_config())

set_desired_capacity/3

set_desired_capacity(GroupName::string(), Capacity::integer(), Config::aws_config()) -> {ok, string()} | {error, term()}

set_desired_capacity(GroupName, Capacity, false, Config)

set_desired_capacity/4

set_desired_capacity(GroupName::string(), Capacity::integer(), HonorCooldown::boolean(), Config::aws_config()) -> {ok, string()} | {error, term()}

Change the desired capacity of the given autoscaling group, optionally ignoring cooldown periods (set false to basically force change). Requires permission for the autoscaling:SetDesiredCapacity action.

suspend_processes/1

suspend_processes(GroupName::string()) -> {ok, string()} | {error, term()}

Suspends Auto Scaling processes for the specified Auto Scaling group. To suspend specific processes, use the ScalingProcesses parameter. To suspend all processes, omit the ScalingProcesses parameter.

suspend_processes/2

suspend_processes(GroupName, Config) -> any()

Suspend the processes. The 2nd parameter can be used to specify a list of ScalingProcesses or [] to suspend all Config a supplied AWS configuration.

suspend_processes/3

suspend_processes(GroupName::string(), ScalingProcesses::[string()], Config::aws_config()) -> {ok, string()} | {error, term()}

terminate_instance/1

terminate_instance(InstanceId::string()) -> {ok, aws_autoscaling_activity()} | {error, term()}

Terminate the given instance using the default configuration without decrementing the desired capacity of the group.

terminate_instance/2

terminate_instance(InstanceId::string(), Config::boolean() | aws_config()) -> {ok, aws_autoscaling_activity()} | {error, term()}

Terminate the given instance. The 2nd parameter can be: 'false' to not decrement the desired capacity of the group 'true' to decrement the desired capacity of the group Config a supplied AWS configuration.

terminate_instance/3

terminate_instance(InstanceId::string(), X2::boolean(), Config::aws_config()) -> {ok, aws_autoscaling_activity()} | {error, term()}

update_auto_scaling_group/2

update_auto_scaling_group(Aws_autoscaling_group::aws_autoscaling_group() | [{string(), term()}], Config::aws_config()) -> ok | {error, term()}

Update AutoScaling group.


Generated by EDoc