Overview

Module erlcloud_ssm

• Description
• Data Types
• Function Index
• Function Details

Description

An Erlang interface to AWS Systems Manager (SSM).

Output is in the form of {ok, Value} or {error, Reason}. The format of Value is controlled by the out option, which defaults to json. The possible values are:

* json - The output from Systems Manager as processed by jsx:decode with no further manipulation.

* record - A record containing all the information from the Systems Manager.

Data Types

delete_parameter_opt()

delete_parameter_opt() = {name, string_param()} | out_opt()

delete_parameter_opts()

delete_parameter_opts() = [delete_parameter_opt()]

get_parameter_opt()

get_parameter_opt() = {name, string_param()} | {with_decryption, boolean()} | out_opt()

get_parameter_opts()

get_parameter_opts() = [get_parameter_opt()]

get_parameters_by_path_filter_opt()

get_parameters_by_path_filter_opt() = {key, string_param()} | {option, string_param()} | {values, [string_param()]}

get_parameters_by_path_filter_opts()

get_parameters_by_path_filter_opts() = [get_parameters_by_path_filter_opt()]

get_parameters_by_path_opt()

get_parameters_by_path_opt() = {max_results, non_neg_integer()} | {next_token, string_param()} | {parameter_filters, get_parameters_by_path_filter_opts()} | {path, string_param()} | {recursive, boolean()} | {with_decryption, boolean()} | out_opt()

get_parameters_by_path_opts()

get_parameters_by_path_opts() = [get_parameters_by_path_opt()]

get_parameters_opt()

get_parameters_opt() = {names, [string_param()]} | {with_decryption, boolean()} | out_opt()

get_parameters_opts()

get_parameters_opts() = [get_parameters_opt()]

out_opt()

out_opt() = {out, out_type()}

out_type()

out_type() = json | record | map

put_parameter_opt()

put_parameter_opt() = {allowed_pattern, string_param()} | {data_type, string_param()} | {description, string_param()} | {key_id, string_param()} | {name, string_param()} | {overwrite, boolean()} | {policies, string_param()} | {tags, [tag_parameter_opts()]} | {tier, string_param()} | {type, string_param()} | {value, string_param()} | out_opt()

put_parameter_opts()

put_parameter_opts() = [put_parameter_opt()]

ssm_return()

ssm_return(Record) = {ok, jsx:json_term() | Record} | {error, term()}

string_param()

string_param() = binary() | string()

tag_parameter_opt()

tag_parameter_opt() = {key, string_param()} | {value, string_param()}

tag_parameter_opts()

tag_parameter_opts() = [tag_parameter_opt()]

Function Index

Function Details

configure/2

configure/3

configure/4

delete_parameter/1

delete_parameter/2

SSM API https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_DeleteParameter.html

Example

Delete a parameter from the system.

get_parameter/1

get_parameter/2

SSM API https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParameter.html

Example

Get information about a parameter by using the parameter name.

get_parameters/1

get_parameters/2

SSM API https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParameters.html

Example

Get information about parameters by using the parameters' names.

get_parameters_by_path/1

get_parameters_by_path/2

SSM API https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_GetParametersByPath.html

Example

Retrieve information about one or more parameters in a specific hierarchy.

new/2

new/3

new/4

put_parameter/1

put_parameter/2

SSM API https://docs.aws.amazon.com/systems-manager/latest/APIReference/API_PutParameter.html

Example

Add a parameter to the system.

Overview

Generated by EDoc