boto3_elasticsearch

Connection module for Amazon Elasticsearch Service using boto3.

depends:

  • boto3 >= 1.28.0

  • botocore >= 1.31.0

configuration:

This module accepts explicit IAM 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 the minion’s config file or as a profile. For example, to specify them 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
All methods return a dict with:

‘result’ key containing a boolean indicating success or failure, ‘error’ key containing the errormessage returned by boto on error, ‘response’ key containing the data of the response returned by boto on success.

codeauthor:

Herbert Buurman <herbert.buurman@ogd.nl>

Added in version 1.0.0.

saltext.boto3.modules.boto3_elasticsearch.__virtual__()[source]

Only load if boto3 is available. Minimum version is enforced via the project’s pyproject.toml dependency declaration.

saltext.boto3.modules.boto3_elasticsearch.add_tags(domain_name=None, arn=None, tags=None, region=None, key=None, keyid=None, profile=None)[source]

Attaches tags to an existing Elasticsearch domain. Tags are a set of case-sensitive key value pairs. An Elasticsearch domain may have up to 10 tags.

domain_name (str, optional):

The name of the Elasticsearch domain you want to add tags to.

arn (str, optional):

The ARN of the Elasticsearch domain you want to add tags to. Specifying this overrides domain_name.

tags (dict, optional):

The dict of tags to add to the Elasticsearch domain.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt myminion boto3_elasticsearch.add_tags domain_name=mydomain tags='{"foo": "bar", "baz": "qux"}'
saltext.boto3.modules.boto3_elasticsearch.cancel_elasticsearch_service_software_update(domain_name, region=None, keyid=None, key=None, profile=None)

Cancels a scheduled service software update for an Amazon ES domain. You can only perform this operation before the AutomatedUpdateDate and when the UpdateStatus is in the PENDING_UPDATE state.

domain_name (str):

The name of the Elasticsearch domain for which to cancel the scheduled service software update.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.cancel_elasticsearch_service_software_update domain_name=mydomain
saltext.boto3.modules.boto3_elasticsearch.create_elasticsearch_domain(domain_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=False, region=None, key=None, keyid=None, profile=None)[source]

Given a valid config, create a domain.

domain_name (str):

The name of the Elasticsearch domain to create.

elasticsearch_version (str, optional):

The version of Elasticsearch to use for the domain.

elasticsearch_cluster_config (dict, optional):

The configuration for the Elasticsearch cluster.

Example:

{
  "InstanceType": "t2.micro.elasticsearch",
  "InstanceCount": 1,
  "DedicatedMasterEnabled": false,
  "ZoneAwarenessEnabled": false
}
ebs_options (dict, optional):

The EBS options for the domain.

Example:

{
  "EBSEnabled": true,
  "VolumeType": "gp2",
  "VolumeSize": 10,
  "Iops": 0
}
access_policies (dict, optional):

The access policies for the domain.

Example:

{
  "Version": "2012-10-17",
  "Statement": [
    {
      "Effect": "Allow",
      "Principal": {"AWS": "*"},
      "Action": "es:*",
      "Resource": "arn:aws:es:us-east-1:111111111111:domain/mydomain/*",
      "Condition": {"IpAddress": {"aws:SourceIp": ["127.0.0.1"]}}
    }
  ]
}
snapshot_options (dict, optional):

The snapshot options for the domain.

Example:

{
  "AutomatedSnapshotStartHour": 0
}
vpc_options (dict, optional):

The VPC options for the domain.

Example:

{
  "SubnetIds": ["subnet-12345678"],
  "SecurityGroupIds": ["sg-12345678"]
}
cognito_options (dict, optional):

The Cognito options for the domain.

Example:

{
  "Enabled": true,
  "UserPoolId": "us-east-1_123456789",
  "IdentityPoolId": "us-east-1:12345678-1234-1234-1234-123456789012",
  "RoleArn": "arn:aws:iam::111111111111:role/CognitoAccessRole"
}
encryption_at_rest_options (dict, optional):

The encryption at rest options for the domain.

Example:

{
  "Enabled": true,
  "KmsKeyId": "arn:aws:kms:us-east-1:111111111111:key/12345678-1234-1234-1234-123456789012"
}
node_to_node_encryption_options (dict, optional):

The node-to-node encryption options for the domain.

Example:

{
  "Enabled": true
}
advanced_options (dict, optional):

The advanced options for the domain.

Example:

{
  "rest.action.multi.allow_explicit_index": "true"
}
log_publishing_options (dict, optional):

The log publishing options for the domain.

Example:

{
  "INDEX_SLOW_LOGS": {
    "CloudWatchLogsLogGroupArn": "arn:aws:logs:us-east-1:111111111111:log-group:my-log-group",
    "Enabled": true
  },
  "SEARCH_SLOW_LOGS": {
    "CloudWatchLogsLogGroupArn": "arn:aws:logs:us-east-1:111111111111:log-group:my-log-group",
    "Enabled": true
  },
  "ES_APPLICATION_LOGS": {
    "CloudWatchLogsLogGroupArn": "arn:aws:logs:us-east-1:111111111111:log-group:my-log-group",
    "Enabled": true
  }
}
blocking (bool, optional):

Whether to block until the domain is available.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

Note

Not all instance types allow enabling encryption at rest. See https://docs.aws.amazon.com /elasticsearch-service/latest/developerguide/aes-supported-instance-types.html

CLI Example:

salt myminion boto3_elasticsearch.create_elasticsearch_domain mydomain         elasticsearch_cluster_config='{           "InstanceType": "t2.micro.elasticsearch",           "InstanceCount": 1,           "DedicatedMasterEnabled": False,           "ZoneAwarenessEnabled": False}'         ebs_options='{           "EBSEnabled": True,           "VolumeType": "gp2",           "VolumeSize": 10,           "Iops": 0}'         access_policies='{           "Version": "2012-10-17",           "Statement": [             {"Effect": "Allow",              "Principal": {"AWS": "*"},              "Action": "es:*",              "Resource": "arn:aws:es:us-east-1:111111111111:domain/mydomain/*",              "Condition": {"IpAddress": {"aws:SourceIp": ["127.0.0.1"]}}}]}'         snapshot_options='{"AutomatedSnapshotStartHour": 0}'         advanced_options='{"rest.action.multi.allow_explicit_index": "true"}'
saltext.boto3.modules.boto3_elasticsearch.delete_elasticsearch_domain(domain_name, blocking=False, region=None, key=None, keyid=None, profile=None)[source]

Permanently deletes the specified Elasticsearch domain and all of its data. Once a domain is deleted, it cannot be recovered.

domain_name (str):

The name of the domain to delete.

blocking (bool, optional):

Whether or not to wait (block) until the Elasticsearch domain has been deleted.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.delete_elasticsearch_domain domain_name="my-domain"
saltext.boto3.modules.boto3_elasticsearch.delete_elasticsearch_service_role(region=None, keyid=None, key=None, profile=None)

Deletes the service-linked role that Elasticsearch Service uses to manage and maintain VPC domains. Role deletion will fail if any existing VPC domains use the role. You must delete any such Elasticsearch domains before deleting the role.

region (str, optional):

The AWS region where the Elasticsearch service role is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.delete_elasticsearch_service_role
saltext.boto3.modules.boto3_elasticsearch.describe_elasticsearch_domain(domain_name, region=None, keyid=None, key=None, profile=None)[source]

Given a domain name gets its status description.

domain_name (str):

The name of the domain to get the status of.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.describe_elasticsearch_domain domain_name="my-domain"
saltext.boto3.modules.boto3_elasticsearch.describe_elasticsearch_domain_config(domain_name, region=None, keyid=None, key=None, profile=None)[source]

Provides cluster configuration information about the specified Elasticsearch domain, such as the state, creation date, update version, and update date for cluster options.

domain_name (str):

The name of the domain to describe.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.describe_elasticsearch_domain_config domain_name="my-domain"
saltext.boto3.modules.boto3_elasticsearch.describe_elasticsearch_domains(domain_names, region=None, keyid=None, key=None, profile=None)[source]

Returns domain configuration information about the specified Elasticsearch domains, including the domain ID, domain endpoint, and domain ARN.

domain_names (list):

A list of domain names to get information for.

region (str, optional):

The AWS region where the Elasticsearch domains are located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt myminion boto3_elasticsearch.describe_elasticsearch_domains '["domain_a", "domain_b"]'
saltext.boto3.modules.boto3_elasticsearch.describe_elasticsearch_instance_type_limits(instance_type, elasticsearch_version, domain_name=None, region=None, keyid=None, key=None, profile=None)

Describe Elasticsearch Limits for a given InstanceType and ElasticsearchVersion. When modifying existing Domain, specify the `` DomainName `` to know what Limits are supported for modifying.

instance_type (str):

The instance type for an Elasticsearch cluster for which Elasticsearch Limits are needed.

elasticsearch_version (str):

Version of Elasticsearch for which Limits are needed.

domain_name (str, optional):

Represents the name of the Domain that we are trying to modify. This should be present only if we are querying for Elasticsearch Limits for an existing domain.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt myminion boto3_elasticsearch.describe_elasticsearch_instance_type_limits           instance_type=r3.8xlarge.elasticsearch           elasticsearch_version='6.2'           domain_name='my-domain'
saltext.boto3.modules.boto3_elasticsearch.describe_reserved_elasticsearch_instance_offerings(reserved_elasticsearch_instance_offering_id=None, region=None, keyid=None, key=None, profile=None)

Lists available reserved Elasticsearch instance offerings.

reserved_elasticsearch_instance_offering_id (str, optional):

The offering identifier filter value. Use this parameter to show only the available offering that matches the specified reservation identifier.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.describe_reserved_elasticsearch_instance_offerings           reserved_elasticsearch_instance_offering_id='my-offering-id'
saltext.boto3.modules.boto3_elasticsearch.describe_reserved_elasticsearch_instances(reserved_elasticsearch_instance_id=None, region=None, keyid=None, key=None, profile=None)

Returns information about reserved Elasticsearch instances for this account.

reserved_elasticsearch_instance_id (str, optional):

The reserved instance identifier filter value. Use this parameter to show only the reservation that matches the specified reserved Elasticsearch instance ID.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

Note

Version 1.9.174 of boto3 has a bug in that reserved_elasticsearch_instance_id is considered a required argument, even though the documentation says otherwise.

CLI Example:

salt-call boto3_elasticsearch.describe_reserved_elasticsearch_instances           reserved_elasticsearch_instance_id='my-instance-id'
saltext.boto3.modules.boto3_elasticsearch.get_compatible_elasticsearch_versions(domain_name=None, region=None, keyid=None, key=None, profile=None)

Returns a list of upgrade compatible Elastisearch versions. You can optionally pass a domain_name to get all upgrade compatible Elasticsearch versions for that specific domain.

domain_name (str, optional):

The name of an Elasticsearch domain. If specified, the function will return upgrade compatible Elasticsearch versions for that specific domain.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.get_compatible_elasticsearch_versions           domain_name='my-domain'
saltext.boto3.modules.boto3_elasticsearch.get_upgrade_history(domain_name, region=None, keyid=None, key=None, profile=None)

Retrieves the complete history of the last 10 upgrades that were performed on the domain.

domain_name (str):

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.get_upgrade_history domain_name='myDomain'
saltext.boto3.modules.boto3_elasticsearch.get_upgrade_status(domain_name, region=None, keyid=None, key=None, profile=None)

Retrieves the latest status of the last upgrade or upgrade eligibility check that was performed on the domain.

domain_name (str):

The name of an Elasticsearch domain. Domain names are unique across the domains owned by an account within an AWS region. Domain names start with a letter or number and can contain the following characters: a-z (lowercase), 0-9, and - (hyphen).

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.get_upgrade_status domain_name='myDomain'
saltext.boto3.modules.boto3_elasticsearch.list_domain_names(region=None, keyid=None, key=None, profile=None)[source]

Returns the name of all Elasticsearch domains owned by the current user’s account.

region (str, optional):

The AWS region where the Elasticsearch domains are located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.list_domain_names region='us-west-2'
saltext.boto3.modules.boto3_elasticsearch.list_elasticsearch_instance_types(elasticsearch_version, domain_name=None, region=None, keyid=None, key=None, profile=None)

List all Elasticsearch instance types that are supported for given ElasticsearchVersion.

elasticsearch_version (str):

The version of Elasticsearch for which to list supported instance types.

domain_name (str, optional):

The name of the Elasticsearch domain. This should be provided only if querying for instance types when modifying an existing domain.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.list_elasticsearch_instance_types             elasticsearch_version='7.10' domain_name='myDomain'
saltext.boto3.modules.boto3_elasticsearch.list_elasticsearch_versions(region=None, keyid=None, key=None, profile=None)

List all supported Elasticsearch versions.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.list_elasticsearch_versions
saltext.boto3.modules.boto3_elasticsearch.list_tags(domain_name=None, arn=None, region=None, key=None, keyid=None, profile=None)[source]

Returns all tags for the given Elasticsearch domain.

domain_name (str, optional):

The name of the Elasticsearch domain for which to list tags.

arn (str, optional):

The ARN of the Elasticsearch domain for which to list tags.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.list_tags domain_name='myDomain'
saltext.boto3.modules.boto3_elasticsearch.purchase_reserved_elasticsearch_instance_offering(reserved_elasticsearch_instance_offering_id, reservation_name, instance_count=None, region=None, keyid=None, key=None, profile=None)

Allows you to purchase reserved Elasticsearch instances.

reserved_elasticsearch_instance_offering_id (str):

The ID of the reserved Elasticsearch instance offering to purchase.

reservation_name (str):

A customer-specified identifier to track this reservation.

instance_count (int, optional):

The number of Elasticsearch instances to reserve.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.purchase_reserved_elasticsearch_instance_offering my_offering_id             my_reservation_name instance_count=1 region=us-west-2 keyid=my_keyid key=my_key profile=my_profile
saltext.boto3.modules.boto3_elasticsearch.remove_tags(tag_keys, domain_name=None, arn=None, region=None, key=None, keyid=None, profile=None)[source]

Removes the specified set of tags from the specified Elasticsearch domain.

tag_keys (list):

List with tag keys you want to remove from the Elasticsearch domain.

domain_name (str, optional):

The name of the Elasticsearch domain you want to remove tags from.

arn (str, optional):

The ARN of the Elasticsearch domain you want to remove tags from. Specifying this overrides domain_name.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt myminion boto3_elasticsearch.remove_tags '["foo", "bar"]' domain_name=my_domain
saltext.boto3.modules.boto3_elasticsearch.start_elasticsearch_service_software_update(domain_name, region=None, keyid=None, key=None, profile=None)

Schedules a service software update for an Amazon ES domain.

domain_name (str):

The name of the domain that you want to update to the latest service software.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt-call boto3_elasticsearch.start_elasticsearch_service_software_update my_domain
saltext.boto3.modules.boto3_elasticsearch.update_elasticsearch_domain_config(domain_name, elasticsearch_cluster_config=None, ebs_options=None, vpc_options=None, access_policies=None, snapshot_options=None, cognito_options=None, advanced_options=None, log_publishing_options=None, blocking=False, region=None, key=None, keyid=None, profile=None)[source]

Modifies the cluster configuration of the specified Elasticsearch domain, for example setting the instance type and the number of instances.

domain_name (str):

The name of the Elasticsearch domain that you want to update.

elasticsearch_cluster_config (dict, optional):

The configuration for the Elasticsearch cluster, such as instance type and count.

Example:

{
    "InstanceType": "t2.micro.elasticsearch",
    "InstanceCount": 1,
    "DedicatedMasterEnabled": false,
    "ZoneAwarenessEnabled": false
}
ebs_options (dict, optional):

The configuration for EBS volumes attached to the domain.

Example:

{
    "EBSEnabled": true,
    "VolumeType": "gp2",
    "VolumeSize": 10,
    "Iops": 0
}
vpc_options (dict, optional):

The VPC configuration for the domain.

Example:

{
    "VPCId": "vpc-12345678",
    "SubnetIds": ["subnet-12345678", "subnet-87654321"],
    "SecurityGroupIds": ["sg-12345678"]
}
access_policies (dict, optional):

The access policies for the domain.

Example:

{
    "Version": "2012-10-17",
    "Statement": [
        {
            "Effect": "Allow",
            "Principal": {"AWS": "*"},
            "Action": "es:*",
            "Resource": "arn:aws:es:us-east-1:111111111111:domain/mydomain/*",
            "Condition": {"IpAddress": {"aws:SourceIp": ["127.0.0.1"]}}
        }
    ]
}
snapshot_options (dict, optional):

The snapshot options for the domain.

Example:

{
    "AutomatedSnapshotStartHour": 0
}
cognito_options (dict, optional):

The Amazon Cognito options for the domain.

Example:

{
    "Enabled": true,
    "UserPoolId": "us-east-1_123456789",
    "IdentityPoolId": "us-east-1:12345678-1234-1234-1234-123456789012",
    "RoleArn": "arn:aws:iam::111111111111:role/CognitoAccessRole"
}
advanced_options (dict, optional):

The advanced options for the domain.

Example:

{
    "rest.action.multi.allow_explicit_index": "true"
}
log_publishing_options (dict, optional):

The log publishing options for the domain.

Example:

{
    "INDEX_SLOW_LOGS": {
        "CloudWatchLogsLogGroupArn": "arn:aws:logs:us-east-1:111111111111:log-group:my-log-group",
        "Enabled": true
    }
}
blocking (bool, optional):

Whether to block until the domain is available after the update.

region (str, optional):

The AWS region where the Elasticsearch domain is located.

keyid (str, optional):

The AWS access key ID.

key (str, optional):

The AWS secret access key.

profile (str, optional):

The profile to use for AWS credentials.

CLI Example:

salt myminion boto3_elasticsearch.update_elasticsearch_domain_config mydomain           elasticsearch_cluster_config='{            "InstanceType": "t2.micro.elasticsearch",             "InstanceCount": 1,             "DedicatedMasterEnabled": false,             "ZoneAwarenessEnabled": false           }'           ebs_options='{            "EBSEnabled": true,             "VolumeType": "gp2",             "VolumeSize": 10,             "Iops": 0           }'           access_policies='{            "Version": "2012-10-17",             "Statement": [{              "Effect": "Allow",               "Principal": {"AWS": "*"},               "Action": "es:*",               "Resource": "arn:aws:es:us-east-1:111111111111:domain/mydomain/*",               "Condition": {"IpAddress": {"aws:SourceIp": ["127.0.0.1"]}}            }]          }'           snapshot_options='{            "AutomatedSnapshotStartHour": 0           }'           advanced_options='{            "rest.action.multi.allow_explicit_index": "true"           }'
saltext.boto3.modules.boto3_elasticsearch.upgrade_elasticsearch_domain(domain_name, target_version, perform_check_only=None, blocking=False, region=None, keyid=None, key=None, profile=None)

Allows you to either upgrade your domain or perform an Upgrade eligibility check to a compatible Elasticsearch version.

domain_name (str):

The name of the Elasticsearch domain to upgrade.

target_version (str):

The version of Elasticsearch that you intend to upgrade the domain to.

perform_check_only (bool):

This flag, when set to True, indicates that an Upgrade Eligibility Check needs to be performed. This will not actually perform the Upgrade.

blocking (bool):

Whether or not to wait (block) until the Elasticsearch domain has been upgraded.

region (str):

The AWS region where the Elasticsearch domain is located.

keyid (str):

The AWS access key ID.

key (str):

The AWS secret access key.

profile (str):

The AWS profile to use.

CLI Example:

salt myminion boto3_elasticsearch.upgrade_elasticsearch_domain mydomain         target_version='6.7'         perform_check_only=True
saltext.boto3.modules.boto3_elasticsearch.exists(domain_name, region=None, key=None, keyid=None, profile=None)[source]

Given a domain name, check to see if the given domain exists.

domain_name (str):

The name of the domain to check.

region (str):

The AWS region where the Elasticsearch domain is located.

keyid (str):

The AWS access key ID.

key (str):

The AWS secret access key.

profile (str):

The AWS profile to use.

CLI Example:

salt-call boto3_elasticsearch.exists mydomain
saltext.boto3.modules.boto3_elasticsearch.wait_for_upgrade(domain_name, region=None, keyid=None, key=None, profile=None)[source]

Block until an upgrade-in-progress for domain name is finished.

domain_name (str):

The name of the domain to wait for an upgrade to finish.

region (str):

The AWS region where the Elasticsearch domain is located.

keyid (str):

The AWS access key ID.

key (str):

The AWS secret access key.

profile (str):

The AWS profile to use.

CLI Example:

salt-call boto3_elasticsearch.wait_for_upgrade mydomain
saltext.boto3.modules.boto3_elasticsearch.check_upgrade_eligibility(domain_name, elasticsearch_version, region=None, keyid=None, key=None, profile=None)

Helper function to determine in one call if an Elasticsearch domain can be upgraded to the specified Elasticsearch version.

This assumes that the Elasticsearch domain is at rest at the moment this function is called. I.e. The domain is not in the process of :

  • being created.

  • being updated.

  • another upgrade running, or a check thereof.

  • being deleted.

Behind the scenes, this does 3 things:

  • Check if elasticsearch_version is among the compatible elasticsearch versions.

  • Perform a check if the Elasticsearch domain is eligible for the upgrade.

  • Check the result of the check and return the result as a boolean.

domain_name (str):

The name of the Elasticsearch domain to check.

elasticsearch_version (str):

The Elasticsearch version to upgrade to.

region (str):

The AWS region where the Elasticsearch domain is located.

keyid (str):

The AWS access key ID.

key (str):

The AWS secret access key.

profile (str):

The AWS profile to use.

CLI Example:

salt myminion boto3_elasticsearch.check_upgrade_eligibility mydomain '6.7'