Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS
  3. API Docs
  4. neptune
  5. ParameterGroup
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

aws.neptune.ParameterGroup

Explore with Pulumi AI

aws logo
AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
pulumi/pulumi-aws

    Manages a Neptune Parameter Group

    Example Usage

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

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

    import pulumi
import pulumi_aws as aws

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

    package main

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

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

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var example = new Aws.Neptune.ParameterGroup("example", new()
    {
        Family = "neptune1",
        Name = "example",
        Parameters = new[]
        {
            new Aws.Neptune.Inputs.ParameterGroupParameterArgs
            {
                Name = "neptune_query_timeout",
                Value = "25",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.ParameterGroup;
import com.pulumi.aws.neptune.ParameterGroupArgs;
import com.pulumi.aws.neptune.inputs.ParameterGroupParameterArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new ParameterGroup("example", ParameterGroupArgs.builder()
            .family("neptune1")
            .name("example")
            .parameters(ParameterGroupParameterArgs.builder()
                .name("neptune_query_timeout")
                .value("25")
                .build())
            .build());

    }
}

    resources:
  example:
    type: aws:neptune:ParameterGroup
    properties:
      family: neptune1
      name: example
      parameters:
        - name: neptune_query_timeout
          value: '25'

    Create ParameterGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new ParameterGroup(name: string, args: ParameterGroupArgs, opts?: CustomResourceOptions);
    @overload
def ParameterGroup(resource_name: str,
                   args: ParameterGroupArgs,
                   opts: Optional[ResourceOptions] = None)

@overload
def ParameterGroup(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   family: Optional[str] = None,
                   description: Optional[str] = None,
                   name: Optional[str] = None,
                   name_prefix: Optional[str] = None,
                   parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
                   tags: Optional[Mapping[str, str]] = None)
    func NewParameterGroup(ctx *Context, name string, args ParameterGroupArgs, opts ...ResourceOption) (*ParameterGroup, error)
    public ParameterGroup(string name, ParameterGroupArgs args, CustomResourceOptions? opts = null)
    public ParameterGroup(String name, ParameterGroupArgs args)
public ParameterGroup(String name, ParameterGroupArgs args, CustomResourceOptions options)

    type: aws:neptune:ParameterGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    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.
    args ParameterGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control 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.
    name String
    The unique name of the resource.
    args ParameterGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var exampleparameterGroupResourceResourceFromNeptuneparameterGroup = new Aws.Neptune.ParameterGroup("exampleparameterGroupResourceResourceFromNeptuneparameterGroup", new()
{
    Family = "string",
    Description = "string",
    Name = "string",
    NamePrefix = "string",
    Parameters = new[]
    {
        new Aws.Neptune.Inputs.ParameterGroupParameterArgs
        {
            Name = "string",
            Value = "string",
            ApplyMethod = "string",
        },
    },
    Tags = 
    {
        { "string", "string" },
    },
});

    example, err := neptune.NewParameterGroup(ctx, "exampleparameterGroupResourceResourceFromNeptuneparameterGroup", &neptune.ParameterGroupArgs{
	Family:      pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	NamePrefix:  pulumi.String("string"),
	Parameters: neptune.ParameterGroupParameterArray{
		&neptune.ParameterGroupParameterArgs{
			Name:        pulumi.String("string"),
			Value:       pulumi.String("string"),
			ApplyMethod: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

    var exampleparameterGroupResourceResourceFromNeptuneparameterGroup = new ParameterGroup("exampleparameterGroupResourceResourceFromNeptuneparameterGroup", ParameterGroupArgs.builder()
    .family("string")
    .description("string")
    .name("string")
    .namePrefix("string")
    .parameters(ParameterGroupParameterArgs.builder()
        .name("string")
        .value("string")
        .applyMethod("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

    exampleparameter_group_resource_resource_from_neptuneparameter_group = aws.neptune.ParameterGroup("exampleparameterGroupResourceResourceFromNeptuneparameterGroup",
    family="string",
    description="string",
    name="string",
    name_prefix="string",
    parameters=[{
        "name": "string",
        "value": "string",
        "applyMethod": "string",
    }],
    tags={
        "string": "string",
    })

    const exampleparameterGroupResourceResourceFromNeptuneparameterGroup = new aws.neptune.ParameterGroup("exampleparameterGroupResourceResourceFromNeptuneparameterGroup", {
    family: "string",
    description: "string",
    name: "string",
    namePrefix: "string",
    parameters: [{
        name: "string",
        value: "string",
        applyMethod: "string",
    }],
    tags: {
        string: "string",
    },
});

    type: aws:neptune:ParameterGroup
properties:
    description: string
    family: string
    name: string
    namePrefix: string
    parameters:
        - applyMethod: string
          name: string
          value: string
    tags:
        string: string

    ParameterGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts 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.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters List<ParameterGroupParameter>
    A list of Neptune parameters to apply.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters []ParameterGroupParameterArgs
    A list of Neptune parameters to apply.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<ParameterGroupParameter>
    A list of Neptune parameters to apply.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters ParameterGroupParameter[]
    A list of Neptune parameters to apply.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters Sequence[ParameterGroupParameterArgs]
    A list of Neptune parameters to apply.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    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.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<Property Map>
    A list of Neptune parameters to apply.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    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.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Arn string
    The Neptune parameter group Amazon Resource Name (ARN).
    Id string
    The provider-assigned unique ID for this managed resource.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Neptune parameter group Amazon Resource Name (ARN).
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn string
    The Neptune parameter group Amazon Resource Name (ARN).
    id string
    The provider-assigned unique ID for this managed resource.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn str
    The Neptune parameter group Amazon Resource Name (ARN).
    id str
    The provider-assigned unique ID for this managed resource.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    arn String
    The Neptune parameter group Amazon Resource Name (ARN).
    id String
    The provider-assigned unique ID for this managed resource.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Look up 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
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        description: Optional[str] = None,
        family: Optional[str] = None,
        name: Optional[str] = None,
        name_prefix: Optional[str] = None,
        parameters: Optional[Sequence[ParameterGroupParameterArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ParameterGroup
    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)
    public static ParameterGroup get(String name, Output<String> id, ParameterGroupState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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.
    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.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters List<ParameterGroupParameter>
    A list of Neptune parameters to apply.
    Tags Dictionary<string, string>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll Dictionary<string, string>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    NamePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    Parameters []ParameterGroupParameterArgs
    A list of Neptune parameters to apply.
    Tags map[string]string
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    TagsAll map[string]string
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<ParameterGroupParameter>
    A list of Neptune parameters to apply.
    tags Map<String,String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String,String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    namePrefix string
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters ParameterGroupParameter[]
    A list of Neptune parameters to apply.
    tags {[key: string]: string}
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll {[key: string]: string}
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    name_prefix str
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters Sequence[ParameterGroupParameterArgs]
    A list of Neptune parameters to apply.
    tags Mapping[str, str]
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tags_all Mapping[str, str]
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    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.
    namePrefix String
    Creates a unique name beginning with the specified prefix. Conflicts with name.
    parameters List<Property Map>
    A list of Neptune parameters to apply.
    tags Map<String>
    A map of tags to assign to the resource. .If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
    tagsAll Map<String>
    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Deprecated: Please use tags instead.

    Supporting Types

    ParameterGroupParameter, ParameterGroupParameterArgs

    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 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.
    apply_method str
    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.

    Import

    Using pulumi import, import Neptune Parameter Groups using the name. For example:

    $ pulumi import aws:neptune/parameterGroup:ParameterGroup some_pg some-pg

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo
    AWS v6.54.0 published on Friday, Sep 27, 2024 by Pulumi
    pulumi/pulumi-aws