software.amazon.awscdk.services.docdb

Interface ClusterParameterGroupProps

All Known Implementing Classes:

ClusterParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-09T19:16:39.748Z")
public interface ClusterParameterGroupProps

Properties for a cluster parameter group.

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.docdb.*;
 ClusterParameterGroupProps clusterParameterGroupProps = ClusterParameterGroupProps.builder()
         .family("family")
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         // the properties below are optional
         .dbClusterParameterGroupName("dbClusterParameterGroupName")
         .description("description")
         .build();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static ClusterParameterGroupProps.Builder	builder()
default java.lang.String	getDbClusterParameterGroupName() The name of the cluster parameter group.
default java.lang.String	getDescription() Description for this parameter group.
java.lang.String	getFamily() Database family of this parameter group.
java.util.Map<java.lang.String,java.lang.String>	getParameters() The parameters in this parameter group.

Method Detail

getFamily

java.lang.String getFamily()

Database family of this parameter group.

getParameters

java.util.Map<java.lang.String,java.lang.String> getParameters()

The parameters in this parameter group.

getDbClusterParameterGroupName

default java.lang.String getDbClusterParameterGroupName()

The name of the cluster parameter group.

Default: A CDK generated name for the cluster parameter group

getDescription

default java.lang.String getDescription()

Description for this parameter group.

Default: a CDK generated description

builder

static ClusterParameterGroupProps.Builder builder()

Returns:

a ClusterParameterGroupProps.Builder of ClusterParameterGroupProps