salt.states.boto_elasticsearch_domain module

Manage Elasticsearch Domains

New in version 2016.11.0.

Create and destroy Elasticsearch domains. Be aware that this interacts with Amazon's services, and so may incur charges.

This module uses boto3, which can be installed via package, or pip.

This module accepts explicit vpc credentials but can also utilize IAM roles assigned to the instance through Instance Profiles. Dynamic credentials are then automatically obtained from AWS API and no further configuration is necessary. More information available here.

If IAM roles are not used you need to specify them either in a pillar file or in the minion's config file:

vpc.keyid: GKTADJGHEIQSXMKKRBJ08H
vpc.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

It's also possible to specify key, keyid and region via a profile, either passed in as a dict, or as a string to pull from pillars or minion config:

myprofile:
    keyid: GKTADJGHEIQSXMKKRBJ08H
    key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
        region: us-east-1
Ensure domain exists:
    boto_elasticsearch_domain.present:
        - DomainName: mydomain
        - profile='user-credentials'
        - ElasticsearchVersion: "2.3"
        - ElasticsearchClusterConfig:
            InstanceType": "t2.micro.elasticsearch"
            InstanceCount: 1
            DedicatedMasterEnabled: False
            ZoneAwarenessEnabled: False
        - EBSOptions:
            EBSEnabled: True
            VolumeType: "gp2"
            VolumeSize: 10
            Iops: 0
        - AccessPolicies:
            Version: "2012-10-17"
            Statement:
              - Effect: "Allow"
              - Principal:
                  AWS: "*"
              - Action:
                - "es:*"
              - Resource: "arn:aws:es:*:111111111111:domain/mydomain/*
              - Condition:
                  IpAddress:
                    "aws:SourceIp":
                      - "127.0.0.1",
                      - "127.0.0.2",
        - SnapshotOptions:
            AutomatedSnapshotStartHour: 0
        - AdvancedOptions:
            rest.action.multi.allow_explicit_index": "true"
        - Tags:
            a: "b"
        - region: us-east-1
        - keyid: GKTADJGHEIQSXMKKRBJ08H
        - key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs
salt.states.boto_elasticsearch_domain.absent(name, DomainName, region=None, key=None, keyid=None, profile=None)

Ensure domain with passed properties is absent.

name
The name of the state definition.
DomainName
Name of the domain.
region
Region to connect to.
key
Secret key to be used.
keyid
Access key to be used.
profile
A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.
salt.states.boto_elasticsearch_domain.present(name, DomainName, ElasticsearchClusterConfig=None, EBSOptions=None, AccessPolicies=None, SnapshotOptions=None, AdvancedOptions=None, Tags=None, region=None, key=None, keyid=None, profile=None, ElasticsearchVersion='1.5')

Ensure domain exists.

name
The name of the state definition
DomainName
Name of the domain.
ElasticsearchClusterConfig

Configuration options for an Elasticsearch domain. Specifies the instance type and number of instances in the domain cluster.

InstanceType (string) -- The instance type for an Elasticsearch cluster.

InstanceCount (integer) -- The number of instances in the specified domain cluster.

DedicatedMasterEnabled (boolean) -- A boolean value to indicate whether a dedicated master node is enabled. See About Dedicated Master Nodes for more information.

ZoneAwarenessEnabled (boolean) -- A boolean value to indicate whether zone awareness is enabled. See About Zone Awareness for more information.

DedicatedMasterType (string) -- The instance type for a dedicated master node.

DedicatedMasterCount (integer) -- Total number of dedicated master nodes, active and on standby, for the cluster.

EBSOptions

Options to enable, disable and specify the type and size of EBS storage volumes.

EBSEnabled (boolean) -- Specifies whether EBS-based storage is enabled.

VolumeType (string) -- Specifies the volume type for EBS-based storage.

VolumeSize (integer) -- Integer to specify the size of an EBS volume.

Iops (integer) -- Specifies the IOPD for a Provisioned IOPS EBS volume (SSD).

AccessPolicies
IAM access policy
SnapshotOptions

Option to set time, in UTC format, of the daily automated snapshot. Default value is 0 hours.

AutomatedSnapshotStartHour (integer) -- Specifies the time, in UTC format, when the service takes a daily automated snapshot of the specified Elasticsearch domain. Default value is 0 hours.

AdvancedOptions
Option to allow references to indices in an HTTP request body. Must be false when configuring access to individual sub-resources. By default, the value is true .
region
Region to connect to.
key
Secret key to be used.
keyid
Access key to be used.
profile
A dict with region, key and keyid, or a pillar key (string) that contains a dict with region, key and keyid.
ElasticsearchVersion
String of format X.Y to specify version for the Elasticsearch domain eg. "1.5" or "2.3".