Module erlcloud_kms

Data Types

create_grant_opt()

create_grant_opt() = {create_grant_opt_key(), term()}

create_grant_opt_key()

create_grant_opt_key() = grant_tokens | constraints | retiring_principal

create_grant_opts()

create_grant_opts() = [create_grant_opt()]

create_key_opt()

create_key_opt() = [{create_key_opt_key(), term()}]

create_key_opt_key()

create_key_opt_key() = description | key_usage | policy

create_key_opts()

create_key_opts() = [create_key_opt()]

decrypt_opt()

decrypt_opt() = {decrypt_opt_key(), term()}

decrypt_opt_key()

decrypt_opt_key() = encryption_context | grant_tokens

decrypt_opts()

decrypt_opts() = [decrypt_opt()]

encrypt_opt()

encrypt_opt() = {encrypt_opt_key(), term()}

encrypt_opt_key()

encrypt_opt_key() = encryption_context | grant_tokens

encrypt_opts()

encrypt_opts() = [encrypt_opt()]

generate_data_key_opt()

generate_data_key_opt() = {generate_data_key_opt_key(), term()}

generate_data_key_opt_key()

generate_data_key_opt_key() = encryption_context | grant_tokens | key_spec | number_of_bytes

generate_data_key_opts()

generate_data_key_opts() = [generate_data_key_opt()]

pagination_opt()

pagination_opt() = {limit, non_neg_integer()} | {marker, string()}

pagination_opts()

pagination_opts() = [pagination_opt()]

re_encrypt_opt()

re_encrypt_opt() = {re_encrypt_opt_key(), term()}

re_encrypt_opt_key()

re_encrypt_opt_key() = destination_encryption_context | grant_tokens | source_encryption_context

re_encrypt_opts()

re_encrypt_opts() = [re_encrypt_opt()]

retire_grant_opt()

retire_grant_opt() = {retire_grant_opt_key(), term()}

retire_grant_opt_key()

retire_grant_opt_key() = key_id | grant_id | grant_token

retire_grant_opts()

retire_grant_opts() = [retire_grant_opt()]

return_val()

return_val() = {ok, proplists:proplist()} | {error, term()}

Function Index

configure/2
configure/3
configure/4
create_alias/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateAlias.html
create_alias/3
create_grant/3 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html
create_grant/4
create_grant/5
create_key/0 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html
create_key/1
create_key/2
decrypt/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html
decrypt/2
decrypt/3
delete_alias/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_DeleteAlias.html
delete_alias/2
describe_key/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html
describe_key/2
disable_key/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html
disable_key/2
disable_key_rotation/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKeyRotation.html
disable_key_rotation/2
enable_key/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKeyRotation.html
enable_key/2
enable_key_rotation/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKeyRotation.html
enable_key_rotation/2
encrypt/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html
encrypt/3
encrypt/4
generate_data_key/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html
generate_data_key/3
generate_data_key_without_plaintext/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html
generate_data_key_without_plaintext/3
generate_random/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateRandom.html
generate_random/2
get_key_policy/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GetKeyPolicy.html
get_key_policy/3
get_key_rotation_status/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GetKeyRotationStatus.html
get_key_rotation_status/2
kms_result_fun/1
list_aliases/0 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ListAliases.html
list_aliases/1
list_aliases/2
list_grants/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ListGrants.html
list_grants/2
list_grants/3
list_key_policies/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeyPolicies.html
list_key_policies/2
list_key_policies/3
list_keys/0 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html
list_keys/1
list_keys/2
new/2
new/3
new/4
put_key_policy/3 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html
put_key_policy/4
re_encrypt/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html
re_encrypt/3
re_encrypt/4
retire_grant/1 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html
retire_grant/2
revoke_grant/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html
revoke_grant/3
update_alias/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_UpdateAlias.html
update_alias/3
update_key_description/2 KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_UpdateKeyDescription.html
update_key_description/3

Function Details

configure/2

configure(AccessKeyID::string(), SecretAccessKey::string()) -> ok

configure/3

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> ok

configure/4

configure(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> ok

create_alias/2

create_alias(AliasName::binary(), TargetKeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateAlias.html

Example

------------------------------------------------------------------------------

create_alias/3

create_alias(AliasName::binary(), TargetKeyId::binary(), Config::aws_config()) -> return_val()

create_grant/3

create_grant(GranteePrincipal::binary(), KeyId::binary(), Operations::[binary() | atom()]) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateGrant.html

Example

------------------------------------------------------------------------------

create_grant/4

create_grant(GranteePrincipal::binary(), KeyId::binary(), Operations::[binary() | atom()], Options::create_grant_opts()) -> return_val()

create_grant/5

create_grant(GranteePrincipal::binary(), KeyId::binary(), Operations::[binary() | atom()], Options::create_grant_opts(), Config::aws_config()) -> return_val()

create_key/0

create_key() -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_CreateKey.html

Example

------------------------------------------------------------------------------

create_key/1

create_key(Options::create_key_opts()) -> return_val()

create_key/2

create_key(Options::create_key_opts(), Config::aws_config()) -> return_val()

decrypt/1

decrypt(CiphertextBlob::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html

Example

------------------------------------------------------------------------------

decrypt/2

decrypt(CiphertextBlob::binary(), Options::decrypt_opts()) -> return_val()

decrypt/3

decrypt(CiphertextBlob::binary(), Options::decrypt_opts(), Config::aws_config()) -> return_val()

delete_alias/1

delete_alias(AliasName::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_DeleteAlias.html

Example

------------------------------------------------------------------------------

delete_alias/2

delete_alias(AliasName::binary(), Config::aws_config()) -> return_val()

describe_key/1

describe_key(KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html

Example

------------------------------------------------------------------------------

describe_key/2

describe_key(KeyId::binary(), Config::aws_config()) -> return_val()

disable_key/1

disable_key(KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKey.html

Example

------------------------------------------------------------------------------

disable_key/2

disable_key(KeyId::binary(), Config::aws_config()) -> return_val()

disable_key_rotation/1

disable_key_rotation(KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_DisableKeyRotation.html

Example

------------------------------------------------------------------------------

disable_key_rotation/2

disable_key_rotation(KeyId::binary(), Config::aws_config()) -> return_val()

enable_key/1

enable_key(KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKeyRotation.html

Example

------------------------------------------------------------------------------

enable_key/2

enable_key(KeyId::binary(), Config::aws_config()) -> return_val()

enable_key_rotation/1

enable_key_rotation(KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_EnableKeyRotation.html

Example

------------------------------------------------------------------------------

enable_key_rotation/2

enable_key_rotation(KeyId::binary(), Config::aws_config()) -> return_val()

encrypt/2

encrypt(KeyId::binary(), Plaintext::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_Encrypt.html

Example

------------------------------------------------------------------------------

encrypt/3

encrypt(KeyId::binary(), Plaintext::binary(), Options::encrypt_opts()) -> return_val()

encrypt/4

encrypt(KeyId::binary(), Plaintext::binary(), Options::encrypt_opts(), Config::aws_config()) -> return_val()

generate_data_key/2

generate_data_key(KeyId::binary(), Options::generate_data_key_opts()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html

Example

------------------------------------------------------------------------------

generate_data_key/3

generate_data_key(KeyId::binary(), Options::generate_data_key_opts(), Config::aws_config()) -> return_val()

generate_data_key_without_plaintext/2

generate_data_key_without_plaintext(KeyId::binary(), Options::generate_data_key_opts()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKeyWithoutPlaintext.html

Example

------------------------------------------------------------------------------

generate_data_key_without_plaintext/3

generate_data_key_without_plaintext(KeyId::binary(), Options::generate_data_key_opts(), Config::aws_config()) -> return_val()

generate_random/1

generate_random(NumberOfBytes::non_neg_integer()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateRandom.html

Example

------------------------------------------------------------------------------

generate_random/2

generate_random(NumberOfBytes::non_neg_integer(), Config::aws_config()) -> return_val()

get_key_policy/2

get_key_policy(KeyId::binary(), PolicyName::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GetKeyPolicy.html

Example

------------------------------------------------------------------------------

get_key_policy/3

get_key_policy(KeyId::binary(), PolicyName::binary(), Config::aws_config()) -> return_val()

get_key_rotation_status/1

get_key_rotation_status(KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_GetKeyRotationStatus.html

Example

------------------------------------------------------------------------------

get_key_rotation_status/2

get_key_rotation_status(KeyId::binary(), Config::aws_config()) -> return_val()

kms_result_fun/1

kms_result_fun(Request::aws_request()) -> aws_request()

list_aliases/0

list_aliases() -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ListAliases.html

Example

------------------------------------------------------------------------------

list_aliases/1

list_aliases(Options::pagination_opts()) -> return_val()

list_aliases/2

list_aliases(Options::pagination_opts(), Config::aws_config()) -> return_val()

list_grants/1

list_grants(KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ListGrants.html

Example

------------------------------------------------------------------------------

list_grants/2

list_grants(KeyId::binary(), Options::pagination_opts()) -> return_val()

list_grants/3

list_grants(KeyId::binary(), Options::pagination_opts(), Config::aws_config()) -> return_val()

list_key_policies/1

list_key_policies(KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeyPolicies.html

Example

------------------------------------------------------------------------------

list_key_policies/2

list_key_policies(KeyId::binary(), Options::pagination_opts()) -> return_val()

list_key_policies/3

list_key_policies(KeyId::binary(), Options::pagination_opts(), Config::aws_config()) -> return_val()

list_keys/0

list_keys() -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html

Example

------------------------------------------------------------------------------

list_keys/1

list_keys(Options::pagination_opts()) -> return_val()

list_keys/2

list_keys(Options::pagination_opts(), Config::aws_config()) -> return_val()

new/2

new(AccessKeyID::string(), SecretAccessKey::string()) -> aws_config()

new/3

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string()) -> aws_config()

new/4

new(AccessKeyID::string(), SecretAccessKey::string(), Host::string(), Port::non_neg_integer()) -> aws_config()

put_key_policy/3

put_key_policy(KeyId::binary(), Policy::binary(), PolicyName::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_PutKeyPolicy.html

Example

------------------------------------------------------------------------------

put_key_policy/4

put_key_policy(KeyId::binary(), Policy::binary(), PolicyName::binary(), Config::aws_config()) -> return_val()

re_encrypt/2

re_encrypt(CiphertextBlob::binary(), DestinationKeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_ReEncrypt.html

Example

------------------------------------------------------------------------------

re_encrypt/3

re_encrypt(CiphertextBlob::binary(), DestinationKeyId::binary(), Options::re_encrypt_opts()) -> return_val()

re_encrypt/4

re_encrypt(CiphertextBlob::binary(), DestinationKeyId::binary(), Options::re_encrypt_opts(), Config::aws_config()) -> return_val()

retire_grant/1

retire_grant(Options::retire_grant_opts()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_RetireGrant.html

Example

------------------------------------------------------------------------------

retire_grant/2

retire_grant(Options::retire_grant_opts(), Config::aws_config()) -> return_val()

revoke_grant/2

revoke_grant(GrantId::binary(), KeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_RevokeGrant.html

Example

------------------------------------------------------------------------------

revoke_grant/3

revoke_grant(GrantId::binary(), KeyId::binary(), Config::aws_config()) -> return_val()

update_alias/2

update_alias(AliasName::binary(), TargetKeyId::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_UpdateAlias.html

Example

------------------------------------------------------------------------------

update_alias/3

update_alias(AliasName::binary(), TargetKeyId::binary(), Config::aws_config()) -> return_val()

update_key_description/2

update_key_description(KeyId::binary(), Description::binary()) -> return_val()

KMS API: http://docs.aws.amazon.com/kms/latest/APIReference/API_UpdateKeyDescription.html

Example

------------------------------------------------------------------------------

update_key_description/3

update_key_description(KeyId::binary(), Description::binary(), Config::aws_config()) -> return_val()


Generated by EDoc