software.amazon.awscdk.services.neptune

Class CfnDBClusterParameterGroup

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.neptune.CfnDBClusterParameterGroup

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.004Z")
 @Stability(value=Stable)
public class CfnDBClusterParameterGroup
extends CfnResource
implements IInspectable

A CloudFormation `AWS::Neptune::DBClusterParameterGroup`.

The AWS::Neptune::DBClusterParameterGroup resource creates a new Amazon Neptune DB cluster parameter group.

Applying a parameter group to a DB cluster might require instances to reboot, resulting in a database outage while the instances reboot.

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;
 CfnDBClusterParameterGroup cfnDBClusterParameterGroup = CfnDBClusterParameterGroup.Builder.create(this, "MyCfnDBClusterParameterGroup")
         .description("description")
         .family("family")
         .parameters(parameters)
         // the properties below are optional
         .name("name")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDBClusterParameterGroup.Builder A fluent builder for CfnDBClusterParameterGroup.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDBClusterParameterGroup(software.constructs.Construct scope, String id, CfnDBClusterParameterGroupProps props) Create a new `AWS::Neptune::DBClusterParameterGroup`.
protected	CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getDescription() Provides the customer-specified description for this DB cluster parameter group.
String	getFamily() Must be `neptune1` .
String	getName() Provides the name of the DB cluster parameter group.
Object	getParameters() The parameters to set for this DB cluster parameter group.
TagManager	getTags() The tags that you want to attach to this parameter group.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) Provides the customer-specified description for this DB cluster parameter group.
void	setFamily(String value) Must be `neptune1` .
void	setName(String value) Provides the name of the DB cluster parameter group.
void	setParameters(Object value) The parameters to set for this DB cluster parameter group.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDBClusterParameterGroup

protected CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObjectRef objRef)

CfnDBClusterParameterGroup

protected CfnDBClusterParameterGroup(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDBClusterParameterGroup

@Stability(value=Stable)
public CfnDBClusterParameterGroup(@NotNull
                                                           software.constructs.Construct scope,
                                                           @NotNull
                                                           String id,
                                                           @NotNull
                                                           CfnDBClusterParameterGroupProps props)

Create a new `AWS::Neptune::DBClusterParameterGroup`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

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

getDescription

@Stability(value=Stable)
 @NotNull
public String getDescription()

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

setDescription

@Stability(value=Stable)
public void setDescription(@NotNull
                                                    String value)

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

getFamily

@Stability(value=Stable)
 @NotNull
public String getFamily()

Must be `neptune1` .

setFamily

@Stability(value=Stable)
public void setFamily(@NotNull
                                               String value)

Must be `neptune1` .

getParameters

@Stability(value=Stable)
 @NotNull
public 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.

setParameters

@Stability(value=Stable)
public void setParameters(@NotNull
                                                   Object value)

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.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

Provides the name of the DB cluster parameter group.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

Provides the name of the DB cluster parameter group.