db_cluster_parameter_group#

Exec module for managing Amazon Neptune DB Cluster Parameter Group.

async idem_aws.exec.aws.neptune.db_cluster_parameter_group.get(hub, ctx, name: str, resource_id: str = None) → Dict[source]#

Retrieves the specified AWS Neptune DB Cluster Parameter Group.

It also fetches the db cluster parameters for the supplied resource_id. Filters is not supported yet as per documentation for this resource on AWS. It returns idem object representation for db_cluster_parameter_group found if resource_id was specified. If resource_id wasn’t specified, it returns the first resource found.

Parameters:

  • name (str) – An Idem name of the resource.

  • resource_id (str, Optional) – DBClusterParameterGroupName of the resource in AWS.

Note

At the time of writing this module, filters parameter is not supported for this resource as per AWS documentation so idem-aws has omitted it.

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 AWS Neptune DB Cluster Parameter Group in “present” format.

Return type:

Dict[bool, list, dict or None]

Examples

Calling this exec module function from the cli:

idem exec aws.neptune.db_cluster_parameter_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.neptune.db_cluster_parameter_group.get(
        ctx, name=name, resource_id=resource_id
    )
async idem_aws.exec.aws.neptune.db_cluster_parameter_group.list_(hub, ctx, name: str = None) → Dict[source]#

Use a list of un-managed neptune db cluster parameter groups as a data-source.

Parameters:

name (str, Optional) – The name of idem state.

Note

At the time of writing this module, filters parameter is not supported for this resource as per AWS documentation so idem-aws has omitted it.

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 AWS Neptune DB Cluster Parameter Group in “present” format.

Return type:

Dict[bool, list, dict or None]

Examples

Calling this exec module function from the cli:

idem exec aws.neptune.db_cluster_parameter_group.list name=name

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

async def state_function(hub, ctx, name, **kwargs):
    ret = await hub.exec.aws.neptune.db_cluster_parameter_group.list(
        ctx, name=name
    )