Class ClusterEngineConfig

The type returned from the IClusterEngine.bindToCluster method.

Inheritance

object

ClusterEngineConfig

Implements

IClusterEngineConfig

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.RDS

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class ClusterEngineConfig : IClusterEngineConfig

Syntax (vb)

Public Class ClusterEngineConfig Implements IClusterEngineConfig

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.RDS;

            ParameterGroup parameterGroup;

            var clusterEngineConfig = new ClusterEngineConfig {
                Features = new ClusterEngineFeatures {
                    S3Export = "s3Export",
                    S3Import = "s3Import",
                    ServerlessV2AutoPauseSupported = false
                },
                ParameterGroup = parameterGroup,
                Port = 123
            };

Synopsis

Constructors

ClusterEngineConfig()

The type returned from the IClusterEngine.bindToCluster method.

Properties

Features	Features supported by the database engine.
ParameterGroup	The ParameterGroup to use for the cluster.
Port	The port to use for this cluster, unless the customer specified the port directly.

Constructors

ClusterEngineConfig()

The type returned from the IClusterEngine.bindToCluster method.

public ClusterEngineConfig()

Remarks

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
            // The values are placeholders you should change.
            using Amazon.CDK.AWS.RDS;

            ParameterGroup parameterGroup;

            var clusterEngineConfig = new ClusterEngineConfig {
                Features = new ClusterEngineFeatures {
                    S3Export = "s3Export",
                    S3Import = "s3Import",
                    ServerlessV2AutoPauseSupported = false
                },
                ParameterGroup = parameterGroup,
                Port = 123
            };

Properties

Features

Features supported by the database engine.

public IClusterEngineFeatures? Features { get; set; }

Property Value

IClusterEngineFeatures

Remarks

Default: - no features

See: https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_DBEngineVersion.html

ParameterGroup

The ParameterGroup to use for the cluster.

public IParameterGroup? ParameterGroup { get; set; }

Property Value

IParameterGroup

Remarks

Default: - no ParameterGroup will be used

Port

The port to use for this cluster, unless the customer specified the port directly.

public double? Port { get; set; }

Property Value

double?

Remarks

Default: - use the default port for clusters (3306)

Implements

IClusterEngineConfig