ParameterGroup

Manages a Neptune Parameter Group

Example Usage

using Pulumi;
using Aws = Pulumi.Aws;

class MyStack : Stack
{
    public MyStack()
    {
        var example = new Aws.Neptune.ParameterGroup("example", new Aws.Neptune.ParameterGroupArgs
        {
            Family = "neptune1",
            Parameters = 
            {
                new Aws.Neptune.Inputs.ParameterGroupParameterArgs
                {
                    Name = "neptune_query_timeout",
                    Value = "25",
                },
            },
        });
    }

}

package main

import (
    "github.com/pulumi/pulumi-aws/sdk/v2/go/aws/neptune"
    "github.com/pulumi/pulumi/sdk/v2/go/pulumi"
)

func main() {
    pulumi.Run(func(ctx *pulumi.Context) error {
        _, err := neptune.NewParameterGroup(ctx, "example", &neptune.ParameterGroupArgs{
            Family: pulumi.String("neptune1"),
            Parameters: neptune.ParameterGroupParameterArray{
                &neptune.ParameterGroupParameterArgs{
                    Name:  pulumi.String("neptune_query_timeout"),
                    Value: pulumi.String("25"),
                },
            },
        })
        if err != nil {
            return err
        }
        return nil
    })
}

import pulumi
import pulumi_aws as aws

example = aws.neptune.ParameterGroup("example",
    family="neptune1",
    parameters=[{
        "name": "neptune_query_timeout",
        "value": "25",
    }])

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const example = new aws.neptune.ParameterGroup("example", {
    family: "neptune1",
    parameters: [{
        name: "neptune_query_timeout",
        value: "25",
    }],
});

Create a ParameterGroup Resource

new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);

def ParameterGroup(resource_name, opts=None, description=None, family=None, name=None, parameters=None, tags=None, __props__=None);

func NewParameterGroup(ctx *Context, name string, args ParameterGroupArgs, opts ...ResourceOption) (*ParameterGroup, error)

public ParameterGroup(string name, ParameterGroupArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args ParameterGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args ParameterGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args ParameterGroupArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

ParameterGroup Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The ParameterGroup resource accepts the following input properties:

Family string: The family of the Neptune parameter group.
Description string: The description of the Neptune parameter group. Defaults to “Managed by Pulumi”.
Name string: The name of the Neptune parameter.
Parameters List<ParameterGroupParameterArgs>: A list of Neptune parameters to apply.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Family string: The family of the Neptune parameter group.
Description string: The description of the Neptune parameter group. Defaults to “Managed by Pulumi”.
Name string: The name of the Neptune parameter.
Parameters []ParameterGroupParameter: A list of Neptune parameters to apply.
Tags map[string]string: A map of tags to assign to the resource.

family string: The family of the Neptune parameter group.
description string: The description of the Neptune parameter group. Defaults to “Managed by Pulumi”.
name string: The name of the Neptune parameter.
parameters ParameterGroupParameter[]: A list of Neptune parameters to apply.
tags {[key: string]: string}: A map of tags to assign to the resource.

family str: The family of the Neptune parameter group.
description str: The description of the Neptune parameter group. Defaults to “Managed by Pulumi”.
name str: The name of the Neptune parameter.
parameters List[ParameterGroupParameter]: A list of Neptune parameters to apply.
tags Dict[str, str]: A map of tags to assign to the resource.

Outputs

All input properties are implicitly available as output properties. Additionally, the ParameterGroup resource produces the following output properties:

Arn string: The Neptune parameter group Amazon Resource Name (ARN).
Id string: The provider-assigned unique ID for this managed resource.

Arn string: The Neptune parameter group Amazon Resource Name (ARN).
Id string: The provider-assigned unique ID for this managed resource.

arn string: The Neptune parameter group Amazon Resource Name (ARN).
id string: The provider-assigned unique ID for this managed resource.

arn str: The Neptune parameter group Amazon Resource Name (ARN).
id str: The provider-assigned unique ID for this managed resource.

Look up an Existing ParameterGroup Resource

Get an existing ParameterGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: ParameterGroupState, opts?: CustomResourceOptions): ParameterGroup

static get(resource_name, id, opts=None, arn=None, description=None, family=None, name=None, parameters=None, tags=None, __props__=None);

func GetParameterGroup(ctx *Context, name string, id IDInput, state *ParameterGroupState, opts ...ResourceOption) (*ParameterGroup, error)

public static ParameterGroup Get(string name, Input<string> id, ParameterGroupState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

Arn string: The Neptune parameter group Amazon Resource Name (ARN).
Description string: The description of the Neptune parameter group. Defaults to “Managed by Pulumi”.
Family string: The family of the Neptune parameter group.
Name string: The name of the Neptune parameter.
Parameters List<ParameterGroupParameterArgs>: A list of Neptune parameters to apply.
Tags Dictionary<string, string>: A map of tags to assign to the resource.

Arn string: The Neptune parameter group Amazon Resource Name (ARN).
Description string: The description of the Neptune parameter group. Defaults to “Managed by Pulumi”.
Family string: The family of the Neptune parameter group.
Name string: The name of the Neptune parameter.
Parameters []ParameterGroupParameter: A list of Neptune parameters to apply.
Tags map[string]string: A map of tags to assign to the resource.

arn string: The Neptune parameter group Amazon Resource Name (ARN).
description string: The description of the Neptune parameter group. Defaults to “Managed by Pulumi”.
family string: The family of the Neptune parameter group.
name string: The name of the Neptune parameter.
parameters ParameterGroupParameter[]: A list of Neptune parameters to apply.
tags {[key: string]: string}: A map of tags to assign to the resource.

arn str: The Neptune parameter group Amazon Resource Name (ARN).
description str: The description of the Neptune parameter group. Defaults to “Managed by Pulumi”.
family str: The family of the Neptune parameter group.
name str: The name of the Neptune parameter.
parameters List[ParameterGroupParameter]: A list of Neptune parameters to apply.
tags Dict[str, str]: A map of tags to assign to the resource.

Supporting Types

ParameterGroupParameter

See the input and output API doc for this type.

Name string: The name of the Neptune parameter.
Value string: The value of the Neptune parameter.
ApplyMethod string: The apply method of the Neptune parameter. Valid values are immediate and pending-reboot. Defaults to pending-reboot.

Name string: The name of the Neptune parameter.
Value string: The value of the Neptune parameter.
ApplyMethod string: The apply method of the Neptune parameter. Valid values are immediate and pending-reboot. Defaults to pending-reboot.

name string: The name of the Neptune parameter.
value string: The value of the Neptune parameter.
applyMethod string: The apply method of the Neptune parameter. Valid values are immediate and pending-reboot. Defaults to pending-reboot.

name str: The name of the Neptune parameter.
value str: The value of the Neptune parameter.
applyMethod str: The apply method of the Neptune parameter. Valid values are immediate and pending-reboot. Defaults to pending-reboot.

Package Details

Repository: https://github.com/pulumi/pulumi-aws
License: Apache-2.0
Notes: This Pulumi package is based on the aws Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud