Package software.amazon.awscdk.services.memorydb

Interface CfnParameterGroupProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnParameterGroupProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
           date="2024-11-15T10:25:02.454Z")
@Stability(Stable)
public interface CfnParameterGroupProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnParameterGroup.

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.memorydb.*;
 Object parameters;
 CfnParameterGroupProps cfnParameterGroupProps = CfnParameterGroupProps.builder()
         .family("family")
         .parameterGroupName("parameterGroupName")
         // the properties below are optional
         .description("description")
         .parameters(parameters)
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnParameterGroupProps.Builder	builder()
default String	getDescription()	A description of the parameter group.
String	getFamily()	The name of the parameter group family that this parameter group is compatible with.
String	getParameterGroupName()	The name of the parameter group.
default Object	getParameters()	Returns the detailed parameter list for the parameter group.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getFamily

@Stability(Stable)
@NotNull
String getFamily()

The name of the parameter group family that this parameter group is compatible with.

See Also:

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

getParameterGroupName

@Stability(Stable)
@NotNull
String getParameterGroupName()

The name of the parameter group.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-memorydb-parametergroup.html#cfn-memorydb-parametergroup-parametergroupname

getDescription

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

A description of the parameter group.

See Also:

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

getParameters

@Stability(Stable)
@Nullable
default Object getParameters()

Returns the detailed parameter list for the parameter group.

See Also:

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

getTags

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

An array of key-value pairs to apply to this resource.

For more information, see Tag .

See Also:

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

builder

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

Returns:

a CfnParameterGroupProps.Builder of CfnParameterGroupProps