db_parameter_group#

State module for AWS Neptune DB Parameter group.

async idem_aws.states.aws.neptune.db_parameter_group.present(hub, ctx, name: str, resource_id: str = None, *, db_parameter_group_family: str, description: str, parameters: ~typing.List[~types.DB Parameter group configuration.Parameter] = None, tags: ~typing.Dict[str, ~typing.Any] = None) → Dict[str, Any][source]#

Creates a new DB parameter group.

A DB parameter group is initially created with the default parameters for the database engine used by the DB instance. To provide custom values for any of the parameters, you must modify the group after creating it using ModifyDBParameterGroup. Once you’ve created a DB parameter group, you need to associate it with your DB instance using ModifyDBInstance. When you associate a new DB parameter group with a running DB instance, you need to reboot the DB instance without failover for the new DB parameter group and associated settings to take effect. After you create a DB parameter group, you should wait at least 5 minutes before creating your first DB instance that uses that DB parameter group as the default parameter group. This allows Amazon Neptune to fully complete the create action before the parameter group is used as the default for a new DB instance. This is especially important for parameters that are critical when creating the default database for a DB instance, such as the character set for the default database defined by the character_set_database parameter. You can use the Parameter Groups option of the Amazon Neptune console or the DescribeDBParameters command to verify that your DB parameter group has been created or modified.

Parameters:

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

  • db_parameter_group_family (str) – The DB parameter group family name. A DB parameter group can be associated with one and only one DB parameter group family, and can be applied only to a DB instance running a database engine and engine version compatible with that DB parameter group family.

  • parameters (list, Optional) – An array of parameter names, values, and the apply method for the parameter update. At least one parameter name, value, and apply method must be supplied; subsequent arguments are optional. Defaults to None.

  • resource_id (str, Optional) – AWS DBParameterGroup Name. Defaults to None.

  • description (str) – The description for the DB parameter group.

  • tags (dict or list, Optional) –

    Dict in the format of {tag-key: tag-value} or List of tags in the format of [{“Key”: tag-key, “Value”: tag-value}] to associate with the DB parameter group. Each tag consists of a key name and an associated value. Defaults to None.

    • Key (str, Optional):

      The key of the tag. Constraints: Tag keys are case-sensitive and accept a maximum of 127 Unicode characters. May not begin with aws:.

    • Value(str, Optional):

      The value of the tag. Constraints: Tag values are case-sensitive and accept a maximum of 256 Unicode characters.

Request Syntax:
[idem_test_aws_neptune_db_parameter_group]:
    aws.neptune.db_parameter_group.present:
        - name: 'string'
        - db_parameter_group_family: 'string'
        - parameters:
            - AllowedValues: 'string'
              ApplyMethod: 'string'
              ApplyType: 'string'
              DataType: 'string'
              Description: 'string'
              IsModifiable: 'string'
              MinimumEngineVersion: 'string'
              ParameterName: 'string'
              ParameterValue: 'string'
              Source: 'string'
        - resource_id: 'string'
        - description: 'string'
        - tags:
            - Key: 'string'
              Value: 'string'
            - Key: 'string'
              Value: 'string'
Returns:

Dict[str, Dict[str,Any]]

Examples

resource_is_present:
  aws.neptune.db_parameter_group.present:
    - name: value
    - db_parameter_group_name: value
    - db_parameter_group_family: value
    - description: value
    - parameters:
      - AllowedValues: 10-2147483647
        ApplyMethod: pending-reboot
        ApplyType: static
        DataType: integer
        Description: Graph query timeout (ms).
        IsModifiable: true
        MinimumEngineVersion: 1.0.1.0
        ParameterName: neptune_query_timeout
        ParameterValue: '120001'
        Source: user
async idem_aws.states.aws.neptune.db_parameter_group.absent(hub, ctx, name: str, resource_id: str = None) → Dict[str, Any][source]#

Deletes a specified DBParameterGroup.

The DBParameterGroup to be deleted can’t be associated with any DB instances.

Parameters:

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

  • resource_id (str, Optional) – AWS Neptune DB Parameter Group Name. Defaults to None Idem automatically considers this resource as absent if this field is not specified.

Request Syntax:
[idem_test_aws_neptune_db_parameter_group]:
    aws.neptune.db_parameter_group.absent:
        - name: 'string'
        - resource_id: 'string'
Returns:

Dict[str, Dict[str,Any]]

Examples

resource_is_absent:
  aws.neptune.db_parameter_group.absent:
    - name: value
    - resource_id: value
async idem_aws.states.aws.neptune.db_parameter_group.describe(hub, ctx) → Dict[str, Dict[str, Any]][source]#

Describe the resource in a way that can be recreated/managed with the corresponding “present” function.

Returns a list of DBParameterGroup descriptions.

Returns:

Dict[str, Dict[str,Any]]

Examples

$ idem describe aws.neptune.db_parameter_group