W3cubDocs

/SaltStack

salt.modules.boto_elasticache

Connection module for Amazon Elasticache

New in version 2014.7.0.

configuration:

This module accepts explicit elasticache 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 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:

elasticache.keyid: GKTADJGHEIQSXMKKRBJ08H
elasticache.key: askdjghsdfjkghWupUjasdflkdfklgjsdfjajkghs

A region may also be specified in the configuration:

elasticache.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
depends:

boto

salt.modules.boto_elasticache.authorize_cache_security_group_ingress(name, ec2_security_group_name, ec2_security_group_owner_id, region=None, key=None, keyid=None, profile=None)

Authorize network ingress from an ec2 security group to a cache security group.

CLI example:

salt myminion boto_elasticache.authorize_cache_security_group_ingress myelasticachesg myec2sg 879879

salt.modules.boto_elasticache.create(name, num_cache_nodes=None, engine=None, cache_node_type=None, replication_group_id=None, engine_version=None, cache_parameter_group_name=None, cache_subnet_group_name=None, cache_security_group_names=None, security_group_ids=None, snapshot_arns=None, preferred_availability_zone=None, preferred_maintenance_window=None, port=None, notification_topic_arn=None, auto_minor_version_upgrade=None, wait=None, region=None, key=None, keyid=None, profile=None)

Create a cache cluster.

CLI example:

salt myminion boto_elasticache.create myelasticache 1 redis cache.t1.micro
cache_security_group_names='["myelasticachesg"]'

salt.modules.boto_elasticache.create_cache_security_group(name, description, region=None, key=None, keyid=None, profile=None)

Create a cache security group.

CLI example:

salt myminion boto_elasticache.create_cache_security_group myelasticachesg 'My Cache Security Group'

salt.modules.boto_elasticache.create_replication_group(name, primary_cluster_id, replication_group_description, wait=None, region=None, key=None, keyid=None, profile=None)

Create replication group.

CLI example:

salt myminion boto_elasticache.create_replication_group myelasticache myprimarycluster description

salt.modules.boto_elasticache.create_subnet_group(name, description, subnet_ids=None, subnet_names=None, tags=None, region=None, key=None, keyid=None, profile=None)

Create an ElastiCache subnet group

CLI example to create an ElastiCache subnet group:

salt myminion boto_elasticache.create_subnet_group my-subnet-group             "group description" subnet_ids='[subnet-12345678, subnet-87654321]'             region=us-east-1

salt.modules.boto_elasticache.delete(name, wait=False, region=None, key=None, keyid=None, profile=None)

Delete a cache cluster.

CLI example:

salt myminion boto_elasticache.delete myelasticache

salt.modules.boto_elasticache.delete_cache_security_group(name, region=None, key=None, keyid=None, profile=None)

Delete a cache security group.

CLI example:

salt myminion boto_elasticache.delete_cache_security_group myelasticachesg 'My Cache Security Group'

salt.modules.boto_elasticache.delete_replication_group(name, region=None, key=None, keyid=None, profile=None)

Delete an ElastiCache replication group.

CLI example:

salt myminion boto_elasticache.delete_replication_group my-replication-group                 region=us-east-1

salt.modules.boto_elasticache.delete_subnet_group(name, region=None, key=None, keyid=None, profile=None)

Delete an ElastiCache subnet group.

CLI example:

salt myminion boto_elasticache.delete_subnet_group my-subnet-group                 region=us-east-1

salt.modules.boto_elasticache.describe_replication_group(name, region=None, key=None, keyid=None, profile=None, parameter=None)

Get replication group information.

CLI example:

salt myminion boto_elasticache.describe_replication_group mygroup

salt.modules.boto_elasticache.exists(name, region=None, key=None, keyid=None, profile=None)

Check to see if a cache cluster exists.

CLI example:

salt myminion boto_elasticache.exists myelasticache

salt.modules.boto_elasticache.get_all_cache_subnet_groups(name=None, region=None, key=None, keyid=None, profile=None)

Return a list of all cache subnet groups with details

CLI example:

salt myminion boto_elasticache.get_all_subnet_groups region=us-east-1

salt.modules.boto_elasticache.get_cache_subnet_group(name, region=None, key=None, keyid=None, profile=None)

Get information about a cache subnet group.

CLI example:

salt myminion boto_elasticache.get_cache_subnet_group mycache_subnet_group

salt.modules.boto_elasticache.get_config(name, region=None, key=None, keyid=None, profile=None)

Get the configuration for a cache cluster.

CLI example:

salt myminion boto_elasticache.get_config myelasticache

salt.modules.boto_elasticache.get_group_host(name, region=None, key=None, keyid=None, profile=None)

Get hostname from replication cache group

CLI example:

salt myminion boto_elasticache.get_group_host myelasticachegroup

salt.modules.boto_elasticache.get_node_host(name, region=None, key=None, keyid=None, profile=None)

Get hostname from cache node

CLI example:

salt myminion boto_elasticache.get_node_host myelasticache

salt.modules.boto_elasticache.group_exists(name, region=None, key=None, keyid=None, profile=None)

Check to see if a replication group exists.

CLI example:

salt myminion boto_elasticache.group_exists myelasticache

salt.modules.boto_elasticache.list_cache_subnet_groups(name=None, region=None, key=None, keyid=None, profile=None)

Return a list of all cache subnet group names

CLI example:

salt myminion boto_elasticache.list_subnet_groups region=us-east-1

salt.modules.boto_elasticache.revoke_cache_security_group_ingress(name, ec2_security_group_name, ec2_security_group_owner_id, region=None, key=None, keyid=None, profile=None)

Revoke network ingress from an ec2 security group to a cache security group.

CLI example:

salt myminion boto_elasticache.revoke_cache_security_group_ingress myelasticachesg myec2sg 879879

salt.modules.boto_elasticache.subnet_group_exists(name, tags=None, region=None, key=None, keyid=None, profile=None)

Check to see if an ElastiCache subnet group exists.

CLI example:

salt myminion boto_elasticache.subnet_group_exists my-param-group                 region=us-east-1

© 2019 SaltStack.
Licensed under the Apache License, Version 2.0.
https://docs.saltstack.com/en/latest/ref/modules/all/salt.modules.boto_elasticache.html