jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-18 23:06:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update Aws_sns notify component configuration (#7258)

Browse Source
This commit is contained in:
Klaas Schoute 2018-10-30 07:42:24 +01:00 committed by Fabian Affolter
parent efcaa6f124
commit 7f0d8427b1
1 changed files with 24 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
source/_components/notify.aws_sns.markdown
View File

@ -32,13 +32,30 @@ notify:
region_name: 'us-east-1'
```
Configuration variables:
- **aws_access_key_id** (*Required if aws_secret_access_key is provided*): Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
- **aws_secret_access_key** (*Required if aws_access_key_id is provided*): Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
- **profile_name** (*Optional*): A credentials profile name.
- **region_name** (*Required*): The region identifier to connect to. The default is `us-east-1`.
- **name** (*Optional*): Setting the optional parameter `name` allows multiple notifiers to be created. The default value is `notify`. The notifier will bind to the service `notify.NOTIFIER_NAME`.
{% configuration %}
aws_access_key_id:
description: Your AWS Access Key ID. If provided, you must also provide an `aws_secret_access_key` and must **not** provide a `profile_name`.
required: Required if aws_secret_access_key is provided
type: string
aws_secret_access_key:
description: Your AWS Secret Access Key. If provided, you must also provide an `aws_access_key_id` and must **not** provide a `profile_name`.
required: Required if aws_access_key_id is provided
type: string
profile_name:
description: A credentials profile name.
required: false
type: string
region_name:
description: The region identifier to connect to.
required: true
default: us-east-1
type: string
name:
description: Setting the optional parameter `name` allows multiple notifiers to be created. The notifier will bind to the service `notify.NOTIFIER_NAME`.
required: false
default: notify
type: string
{% endconfiguration %}
### {% linkable_title Usage %}