Package software.amazon.awscdk.services.neptune

Interface CfnDBClusterParameterGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDBClusterParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-12-27T17:02:05.194Z")
@Stability(Stable)
public interface CfnDBClusterParameterGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDBClusterParameterGroup.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.neptune.*;
 Object parameters;
 CfnDBClusterParameterGroupProps cfnDBClusterParameterGroupProps = CfnDBClusterParameterGroupProps.builder()
         .description("description")
         .family("family")
         .parameters(parameters)
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDBClusterParameterGroupProps.Builder	A builder for CfnDBClusterParameterGroupProps
static final class	CfnDBClusterParameterGroupProps.Jsii$Proxy	An implementation for CfnDBClusterParameterGroupProps

Method Summary

Modifier and Type	Method	Description
static CfnDBClusterParameterGroupProps.Builder	builder()
String	getDescription()	Provides the customer-specified description for this DB cluster parameter group.
String	getFamily()	Must be neptune1 for engine versions prior to 1.2.0.0 , or neptune1.2 for engine version 1.2.0.0 and higher.
default String	getName()	Provides the name of the DB cluster parameter group.
Object	getParameters()	The parameters to set for this DB cluster parameter group.
default List<CfnTag>	getTags()	The tags that you want to attach to this parameter group.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

Provides the customer-specified description for this DB cluster parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-description

getFamily

@Stability(Stable)
@NotNull
String getFamily()

Must be neptune1 for engine versions prior to 1.2.0.0 , or neptune1.2 for engine version 1.2.0.0 and higher.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-family

getParameters

@Stability(Stable)
@NotNull
Object getParameters()

The parameters to set for this DB cluster parameter group.

The parameters are expressed as a JSON object consisting of key-value pairs.

If you update the parameters, some interruption may occur depending on which parameters you update.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-parameters

getName

@Stability(Stable)
@Nullable
default String getName()

Provides the name of the DB cluster parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-name

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

The tags that you want to attach to this parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-neptune-dbclusterparametergroup.html#cfn-neptune-dbclusterparametergroup-tags

builder

@Stability(Stable)
static CfnDBClusterParameterGroupProps.Builder builder()

Returns:

a CfnDBClusterParameterGroupProps.Builder of CfnDBClusterParameterGroupProps