AWS v6.76.0, Apr 8 25

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

aws.neptune.ClusterParameterGroup

Explore with Pulumi AI

AWS v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

Example Usage

TypeScript
Python
Go
C#
Java
YAML

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

const example = new aws.neptune.ClusterParameterGroup("example", {
    family: "neptune1",
    name: "example",
    description: "neptune cluster parameter group",
    parameters: [{
        name: "neptune_enable_audit_log",
        value: "1",
    }],
});

import pulumi
import pulumi_aws as aws

example = aws.neptune.ClusterParameterGroup("example",
    family="neptune1",
    name="example",
    description="neptune cluster parameter group",
    parameters=[{
        "name": "neptune_enable_audit_log",
        "value": "1",
    }])

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.NewClusterParameterGroup(ctx, "example", &neptune.ClusterParameterGroupArgs{
			Family:      pulumi.String("neptune1"),
			Name:        pulumi.String("example"),
			Description: pulumi.String("neptune cluster parameter group"),
			Parameters: neptune.ClusterParameterGroupParameterArray{
				&neptune.ClusterParameterGroupParameterArgs{
					Name:  pulumi.String("neptune_enable_audit_log"),
					Value: pulumi.String("1"),
				},
			},
		})
		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.ClusterParameterGroup("example", new()
    {
        Family = "neptune1",
        Name = "example",
        Description = "neptune cluster parameter group",
        Parameters = new[]
        {
            new Aws.Neptune.Inputs.ClusterParameterGroupParameterArgs
            {
                Name = "neptune_enable_audit_log",
                Value = "1",
            },
        },
    });

});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.neptune.ClusterParameterGroup;
import com.pulumi.aws.neptune.ClusterParameterGroupArgs;
import com.pulumi.aws.neptune.inputs.ClusterParameterGroupParameterArgs;
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 ClusterParameterGroup("example", ClusterParameterGroupArgs.builder()
            .family("neptune1")
            .name("example")
            .description("neptune cluster parameter group")
            .parameters(ClusterParameterGroupParameterArgs.builder()
                .name("neptune_enable_audit_log")
                .value(1)
                .build())
            .build());

    }
}

resources:
  example:
    type: aws:neptune:ClusterParameterGroup
    properties:
      family: neptune1
      name: example
      description: neptune cluster parameter group
      parameters:
        - name: neptune_enable_audit_log
          value: 1

Create ClusterParameterGroup Resource

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

new ClusterParameterGroup(name: string, args: ClusterParameterGroupArgs, opts?: CustomResourceOptions);

@overload
def ClusterParameterGroup(resource_name: str,
                          args: ClusterParameterGroupArgs,
                          opts: Optional[ResourceOptions] = None)

@overload
def ClusterParameterGroup(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[ClusterParameterGroupParameterArgs]] = None,
                          tags: Optional[Mapping[str, str]] = None)

func NewClusterParameterGroup(ctx *Context, name string, args ClusterParameterGroupArgs, opts ...ResourceOption) (*ClusterParameterGroup, error)

public ClusterParameterGroup(string name, ClusterParameterGroupArgs args, CustomResourceOptions? opts = null)

public ClusterParameterGroup(String name, ClusterParameterGroupArgs args)
public ClusterParameterGroup(String name, ClusterParameterGroupArgs args, CustomResourceOptions options)

type: aws:neptune:ClusterParameterGroup
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 ClusterParameterGroupArgs: 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 ClusterParameterGroupArgs: 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 ClusterParameterGroupArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

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

name String: The unique name of the resource.
args ClusterParameterGroupArgs: 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.

TypeScript
Python
Go
C#
Java
YAML

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

example, err := neptune.NewClusterParameterGroup(ctx, "awsClusterParameterGroupResource", &neptune.ClusterParameterGroupArgs{
	Family:      pulumi.String("string"),
	Description: pulumi.String("string"),
	Name:        pulumi.String("string"),
	NamePrefix:  pulumi.String("string"),
	Parameters: neptune.ClusterParameterGroupParameterArray{
		&neptune.ClusterParameterGroupParameterArgs{
			Name:        pulumi.String("string"),
			Value:       pulumi.String("string"),
			ApplyMethod: pulumi.String("string"),
		},
	},
	Tags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
})

var awsClusterParameterGroupResource = new ClusterParameterGroup("awsClusterParameterGroupResource", ClusterParameterGroupArgs.builder()
    .family("string")
    .description("string")
    .name("string")
    .namePrefix("string")
    .parameters(ClusterParameterGroupParameterArgs.builder()
        .name("string")
        .value("string")
        .applyMethod("string")
        .build())
    .tags(Map.of("string", "string"))
    .build());

aws_cluster_parameter_group_resource = aws.neptune.ClusterParameterGroup("awsClusterParameterGroupResource",
    family="string",
    description="string",
    name="string",
    name_prefix="string",
    parameters=[{
        "name": "string",
        "value": "string",
        "apply_method": "string",
    }],
    tags={
        "string": "string",
    })

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

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

ClusterParameterGroup Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The ClusterParameterGroup resource accepts the following input properties:

Family string: The family of the neptune cluster parameter group.
Description string: The description of the neptune cluster 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<ClusterParameterGroupParameter>: 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 cluster parameter group.
Description string: The description of the neptune cluster 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 []ClusterParameterGroupParameterArgs: 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 cluster parameter group.
description String: The description of the neptune cluster 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<ClusterParameterGroupParameter>: 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 cluster parameter group.
description string: The description of the neptune cluster 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 ClusterParameterGroupParameter[]: 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 cluster parameter group.
description str: The description of the neptune cluster 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[ClusterParameterGroupParameterArgs]: 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 cluster parameter group.
description String: The description of the neptune cluster 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 ClusterParameterGroup resource produces the following output properties:

Arn string: The ARN of the neptune cluster parameter group.
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 ARN of the neptune cluster parameter group.
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 ARN of the neptune cluster parameter group.
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 ARN of the neptune cluster parameter group.
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 ARN of the neptune cluster parameter group.
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 ARN of the neptune cluster parameter group.
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 ClusterParameterGroup Resource

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

TypeScript
Python
Go
C#
Java
YAML

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

@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[ClusterParameterGroupParameterArgs]] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> ClusterParameterGroup

func GetClusterParameterGroup(ctx *Context, name string, id IDInput, state *ClusterParameterGroupState, opts ...ResourceOption) (*ClusterParameterGroup, error)

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

public static ClusterParameterGroup get(String name, Output<String> id, ClusterParameterGroupState state, CustomResourceOptions options)

resources:  _:    type: aws:neptune:ClusterParameterGroup    get:      id: ${id}

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 ARN of the neptune cluster parameter group.
Description string: The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi".
Family string: The family of the neptune cluster 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<ClusterParameterGroupParameter>: 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 ARN of the neptune cluster parameter group.
Description string: The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi".
Family string: The family of the neptune cluster 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 []ClusterParameterGroupParameterArgs: 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 ARN of the neptune cluster parameter group.
description String: The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi".
family String: The family of the neptune cluster 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<ClusterParameterGroupParameter>: 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 ARN of the neptune cluster parameter group.
description string: The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi".
family string: The family of the neptune cluster 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 ClusterParameterGroupParameter[]: 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 ARN of the neptune cluster parameter group.
description str: The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi".
family str: The family of the neptune cluster 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[ClusterParameterGroupParameterArgs]: 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 ARN of the neptune cluster parameter group.
description String: The description of the neptune cluster parameter group. Defaults to "Managed by Pulumi".
family String: The family of the neptune cluster 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

ClusterParameterGroupParameter
, ClusterParameterGroupParameterArgs

Name string: The name of the neptune parameter.
Value string: The value of the neptune parameter.
ApplyMethod string: 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: 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: 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: 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: 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: Valid values are immediate and pending-reboot. Defaults to pending-reboot.

Import

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

$ pulumi import aws:neptune/clusterParameterGroup:ClusterParameterGroup cluster_pg production-pg-1

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 v6.76.0 published on Tuesday, Apr 8, 2025 by Pulumi

pulumi/pulumi-aws

aws.neptune.ClusterParameterGroup

On this page

On this page

Example Usage

Create ClusterParameterGroup Resource

Constructor syntax

Parameters

Constructor example

ClusterParameterGroup Resource Properties

Inputs

Outputs

Look up Existing ClusterParameterGroup Resource

Supporting Types

ClusterParameterGroupParameter
, ClusterParameterGroupParameterArgs

Import

Package Details

On this page

On this page

aws.neptune.ClusterParameterGroup

On this page

On this page

Example Usage

Create ClusterParameterGroup Resource

Constructor syntax

Parameters

Constructor example

ClusterParameterGroup Resource Properties

Inputs

Outputs

Look up Existing ClusterParameterGroup Resource

Supporting Types

ClusterParameterGroupParameter, ClusterParameterGroupParameterArgs

Import

Package Details

On this page

On this page

ClusterParameterGroupParameter
, ClusterParameterGroupParameterArgs