replication_group

Exec module for managing Amazon Elasticache Replication Groups.

async idem_aws.exec.aws.elasticache.replication_group.get(hub, ctx, name: str, resource_id: str) → Dict

Retrieves the specified AWS Elasticache Replication Group.

Arg:

name(str):

An Idem name of the resource.

resource_id(str):

The ID of the replication group in Amazon Web Services.

Returns:

result(bool):

Whether the result of the function has been successful (True) or not (False).

comment(list):

A list of messages.

ret(dict or None):

The Elasticache Replication Group in “present” format.

Return type:

Dict[bool, list, dict or None]

Examples

Calling this exec module function from the cli:

idem exec aws.elasticache.replication_group.get name="idem_name" resource_id="resource_id"

Calling this exec module function from within a state module in pure python:

async def state_function(hub, ctx, name, resource_id, **kwargs):
    ret = await hub.exec.aws.elasticache.replication_group.get(
        ctx, name=name, resource_id=resource_id
    )