New in version Natrium.
configuration: | This module accepts explicit AWS credentials but can also utilize IAM roles assigned to the instance trough Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More Information available at: http://docs.aws.amazon.com/AWSEC2/latest/UserGuide/iam-roles-for-amazon-ec2.html
If IAM roles are not used you need to specify them either in a pillar or in the minion's config file: es.keyid: GKTADJGHEIQSXMKKRBJ08H
es.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
A region may also be specified in the configuration: es.region: us-east-1
If a region is not specified, the default is us-east-1. It's also possible to specify key, keyid and region via a profile, either as a passed in dict, or as a string to pull from pillars or minion config: myprofile:
keyid: GKTADJGHEIQSXMKKRBJ08H
key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
region: us-east-1
|
---|---|
codeauthor: | Herbert Buurman <herbert.buurman@ogd.nl> |
depends: | boto3 |
salt.states.boto3_elasticsearch.
absent
(name, blocking=True, region=None, keyid=None, key=None, profile=None)¶Ensure the Elasticsearch Domain specified does not exist.
Parameters: |
---|
New in version Natrium.
Example:
Remove Elasticsearch Domain:
boto3_elasticsearch.absent:
- name: my_domain
- region: eu-west-1
salt.states.boto3_elasticsearch.
latest
(name, minor_only=True, region=None, keyid=None, key=None, profile=None)¶Ensures the Elasticsearch domain specifies runs on the latest compatible version of elasticsearch, upgrading it if it is not.
Note that this operation is blocking until the upgrade is complete.
Parameters: |
---|
New in version Natrium.
Example:
The following example will ensure the elasticsearch domain my_domain
is
upgraded to the latest minor version. So if it is currently 5.1 it will be
upgraded to 5.6.
Upgrade Elasticsearch Domain:
boto3_elasticsearch.latest:
- name: my_domain
- minor_only: True
- region: eu-west-1
salt.states.boto3_elasticsearch.
present
(name, elasticsearch_version=None, elasticsearch_cluster_config=None, ebs_options=None, access_policies=None, snapshot_options=None, vpc_options=None, cognito_options=None, encryption_at_rest_options=None, node_to_node_encryption_options=None, advanced_options=None, log_publishing_options=None, blocking=True, tags=None, region=None, keyid=None, key=None, profile=None)¶Ensure an Elasticsearch Domain exists.
Parameters: |
|
---|
New in version Natrium.
Example:
This will create an elasticsearch domain consisting of a single t2.small instance in the eu-west-1 region (Ireland) and will wait until the instance is available before returning from the state.
Create new domain:
boto3_elasticsearch.present:
- name: my_domain
- elasticsearch_version: '5.1'
- elasticsearch_cluster_config:
InstanceType: t2.small.elasticsearch
InstanceCount: 1
DedicatedMasterEnabled: False
ZoneAwarenessEnabled: False
- ebs_options:
EBSEnabled: True
VolumeType: gp2
VolumeSize: 10
- snapshot_options:
AutomatedSnapshotStartHour: 3
- vpc_options:
SubnetIds:
- subnet-12345678
SecurityGroupIds:
- sg-12345678
- node_to_node_encryption_options:
Enabled: False
- region: eu-west-1
- tags:
foo: bar
baz: qux
salt.states.boto3_elasticsearch.
tagged
(name, tags=None, replace=False, region=None, keyid=None, key=None, profile=None)¶Ensures the Elasticsearch domain has the tags provided.
Adds tags to the domain unless replace
is set to True
, in which
case all existing tags will be replaced with the tags provided in tags
.
(This will remove all tags if replace
is True
and tags
is empty).
Parameters: |
---|
New in version Natrium.
salt.states.boto3_elasticsearch.
upgraded
(name, elasticsearch_version, blocking=True, region=None, keyid=None, key=None, profile=None)¶Ensures the Elasticsearch domain specified runs on the specified version of elasticsearch. Only upgrades are possible as downgrades require a manual snapshot and an S3 bucket to store them in.
Note that this operation is blocking until the upgrade is complete.
Parameters: |
---|
New in version Natrium.
Example:
Upgrade Elasticsearch Domain:
boto3_elasticsearch.upgraded:
- name: my_domain
- elasticsearch_version: '7.2'
- region: eu-west-1
Docs for previous releases are available on readthedocs.org.
Latest Salt release: latest_release
salt.states.boto3_elasticache module