Class CfnCluster
Creates a new MSK cluster.
Inherited Members
Namespace: Amazon.CDK.AWS.MSK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnCluster : CfnResource, IInspectable, IClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Syntax (vb)
Public Class CfnCluster Inherits CfnResource Implements IInspectable, IClusterRef, IConstruct, IDependable, IEnvironmentAware, ITaggable
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
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.MSK;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
BrokerNodeGroupInfo = new BrokerNodeGroupInfoProperty {
ClientSubnets = new [] { "clientSubnets" },
InstanceType = "instanceType",
// the properties below are optional
BrokerAzDistribution = "brokerAzDistribution",
ConnectivityInfo = new ConnectivityInfoProperty {
NetworkType = "networkType",
PublicAccess = new PublicAccessProperty {
Type = "type"
},
VpcConnectivity = new VpcConnectivityProperty {
ClientAuthentication = new VpcConnectivityClientAuthenticationProperty {
Sasl = new VpcConnectivitySaslProperty {
Iam = new VpcConnectivityIamProperty {
Enabled = false
},
Scram = new VpcConnectivityScramProperty {
Enabled = false
}
},
Tls = new VpcConnectivityTlsProperty {
Enabled = false
}
}
}
},
SecurityGroups = new [] { "securityGroups" },
StorageInfo = new StorageInfoProperty {
EbsStorageInfo = new EBSStorageInfoProperty {
ProvisionedThroughput = new ProvisionedThroughputProperty {
Enabled = false,
VolumeThroughput = 123
},
VolumeSize = 123
}
}
},
ClusterName = "clusterName",
KafkaVersion = "kafkaVersion",
NumberOfBrokerNodes = 123,
// the properties below are optional
ClientAuthentication = new ClientAuthenticationProperty {
Sasl = new SaslProperty {
Iam = new IamProperty {
Enabled = false
},
Scram = new ScramProperty {
Enabled = false
}
},
Tls = new TlsProperty {
CertificateAuthorityArnList = new [] { "certificateAuthorityArnList" },
Enabled = false
},
Unauthenticated = new UnauthenticatedProperty {
Enabled = false
}
},
ConfigurationInfo = new ConfigurationInfoProperty {
Arn = "arn",
Revision = 123
},
CurrentVersion = "currentVersion",
EncryptionInfo = new EncryptionInfoProperty {
EncryptionAtRest = new EncryptionAtRestProperty {
DataVolumeKmsKeyId = "dataVolumeKmsKeyId"
},
EncryptionInTransit = new EncryptionInTransitProperty {
ClientBroker = "clientBroker",
InCluster = false
}
},
EnhancedMonitoring = "enhancedMonitoring",
LoggingInfo = new LoggingInfoProperty {
BrokerLogs = new BrokerLogsProperty {
CloudWatchLogs = new CloudWatchLogsProperty {
Enabled = false,
// the properties below are optional
LogGroup = "logGroup"
},
Firehose = new FirehoseProperty {
Enabled = false,
// the properties below are optional
DeliveryStream = "deliveryStream"
},
S3 = new S3Property {
Enabled = false,
// the properties below are optional
Bucket = "bucket",
Prefix = "prefix"
}
},
// the properties below are optional
AuthorizerLogs = new AuthorizerLogsProperty {
CloudWatchLogs = new CloudWatchLogsProperty {
Enabled = false,
// the properties below are optional
LogGroup = "logGroup"
},
Firehose = new FirehoseProperty {
Enabled = false,
// the properties below are optional
DeliveryStream = "deliveryStream"
},
S3 = new S3Property {
Enabled = false,
// the properties below are optional
Bucket = "bucket",
Prefix = "prefix"
}
}
},
OpenMonitoring = new OpenMonitoringProperty {
Prometheus = new PrometheusProperty {
JmxExporter = new JmxExporterProperty {
EnabledInBroker = false
},
NodeExporter = new NodeExporterProperty {
EnabledInBroker = false
}
}
},
Rebalancing = new RebalancingProperty {
Status = "status"
},
StorageMode = "storageMode",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
ZookeeperAccess = new ZookeeperAccessProperty {
Enabled = false
}
});
Synopsis
Constructors
| CfnCluster(Construct, string, ICfnClusterProps) | Create a new |
Properties
| AttrArn | The Amazon Resource Name (ARN) of the MSK cluster. |
| AttrCurrentVersion | The current version of the MSK cluster. |
| BrokerNodeGroupInfo | Information about the broker nodes in the cluster. |
| CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
| CfnProperties | Creates a new MSK cluster. |
| CfnPropertyNames | Creates a new MSK cluster. |
| ClientAuthentication | Includes all client authentication related information. |
| ClusterName | The name of the cluster. |
| ClusterRef | A reference to a Cluster resource. |
| ConfigurationInfo | Represents the configuration that you want MSK to use for the cluster. |
| CurrentVersion | Creates a new MSK cluster. |
| EncryptionInfo | Includes all encryption-related information. |
| EnhancedMonitoring | Specifies the level of monitoring for the MSK cluster. |
| KafkaVersion | The version of Apache Kafka. |
| LoggingInfo | Logging info details for the cluster. |
| NumberOfBrokerNodes | The number of broker nodes in the cluster. |
| OpenMonitoring | The settings for open monitoring. |
| Rebalancing | Creates a new MSK cluster. |
| StorageMode | This controls storage mode for supported storage tiers. |
| Tags | Tag Manager which manages the tags for this resource. |
| TagsRaw | An arbitrary set of tags (key-value pairs) for the cluster. |
| ZookeeperAccess | Creates a new MSK cluster. |
Methods
| ArnForCluster(IClusterRef) | Creates a new MSK cluster. |
| Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
| IsCfnCluster(object) | Checks whether the given object is a CfnCluster. |
| RenderProperties(IDictionary<string, object>) | Creates a new MSK cluster. |
Constructors
CfnCluster(Construct, string, ICfnClusterProps)
Create a new AWS::MSK::Cluster.
public CfnCluster(Construct scope, string id, ICfnClusterProps props)
Parameters
- scope Construct
Scope in which this resource is defined.
- id string
Construct identifier for this resource (unique in its scope).
- props ICfnClusterProps
Resource properties.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
Properties
AttrArn
The Amazon Resource Name (ARN) of the MSK cluster.
public virtual string AttrArn { get; }
Property Value
Remarks
CloudformationAttribute: Arn
AttrCurrentVersion
The current version of the MSK cluster.
public virtual string AttrCurrentVersion { get; }
Property Value
Remarks
CloudformationAttribute: CurrentVersion
BrokerNodeGroupInfo
Information about the broker nodes in the cluster.
public virtual object BrokerNodeGroupInfo { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnCluster.IBrokerNodeGroupInfoProperty
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
CfnProperties
Creates a new MSK cluster.
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
CfnPropertyNames
Creates a new MSK cluster.
protected override IDictionary<string, string> CfnPropertyNames { get; }
Property Value
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
ClientAuthentication
Includes all client authentication related information.
public virtual object? ClientAuthentication { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnCluster.IClientAuthenticationProperty
ClusterName
The name of the cluster.
public virtual string ClusterName { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
ClusterRef
A reference to a Cluster resource.
public virtual IClusterReference ClusterRef { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
ConfigurationInfo
Represents the configuration that you want MSK to use for the cluster.
public virtual object? ConfigurationInfo { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnCluster.IConfigurationInfoProperty
CurrentVersion
Creates a new MSK cluster.
public virtual string? CurrentVersion { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
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.MSK;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
BrokerNodeGroupInfo = new BrokerNodeGroupInfoProperty {
ClientSubnets = new [] { "clientSubnets" },
InstanceType = "instanceType",
// the properties below are optional
BrokerAzDistribution = "brokerAzDistribution",
ConnectivityInfo = new ConnectivityInfoProperty {
NetworkType = "networkType",
PublicAccess = new PublicAccessProperty {
Type = "type"
},
VpcConnectivity = new VpcConnectivityProperty {
ClientAuthentication = new VpcConnectivityClientAuthenticationProperty {
Sasl = new VpcConnectivitySaslProperty {
Iam = new VpcConnectivityIamProperty {
Enabled = false
},
Scram = new VpcConnectivityScramProperty {
Enabled = false
}
},
Tls = new VpcConnectivityTlsProperty {
Enabled = false
}
}
}
},
SecurityGroups = new [] { "securityGroups" },
StorageInfo = new StorageInfoProperty {
EbsStorageInfo = new EBSStorageInfoProperty {
ProvisionedThroughput = new ProvisionedThroughputProperty {
Enabled = false,
VolumeThroughput = 123
},
VolumeSize = 123
}
}
},
ClusterName = "clusterName",
KafkaVersion = "kafkaVersion",
NumberOfBrokerNodes = 123,
// the properties below are optional
ClientAuthentication = new ClientAuthenticationProperty {
Sasl = new SaslProperty {
Iam = new IamProperty {
Enabled = false
},
Scram = new ScramProperty {
Enabled = false
}
},
Tls = new TlsProperty {
CertificateAuthorityArnList = new [] { "certificateAuthorityArnList" },
Enabled = false
},
Unauthenticated = new UnauthenticatedProperty {
Enabled = false
}
},
ConfigurationInfo = new ConfigurationInfoProperty {
Arn = "arn",
Revision = 123
},
CurrentVersion = "currentVersion",
EncryptionInfo = new EncryptionInfoProperty {
EncryptionAtRest = new EncryptionAtRestProperty {
DataVolumeKmsKeyId = "dataVolumeKmsKeyId"
},
EncryptionInTransit = new EncryptionInTransitProperty {
ClientBroker = "clientBroker",
InCluster = false
}
},
EnhancedMonitoring = "enhancedMonitoring",
LoggingInfo = new LoggingInfoProperty {
BrokerLogs = new BrokerLogsProperty {
CloudWatchLogs = new CloudWatchLogsProperty {
Enabled = false,
// the properties below are optional
LogGroup = "logGroup"
},
Firehose = new FirehoseProperty {
Enabled = false,
// the properties below are optional
DeliveryStream = "deliveryStream"
},
S3 = new S3Property {
Enabled = false,
// the properties below are optional
Bucket = "bucket",
Prefix = "prefix"
}
},
// the properties below are optional
AuthorizerLogs = new AuthorizerLogsProperty {
CloudWatchLogs = new CloudWatchLogsProperty {
Enabled = false,
// the properties below are optional
LogGroup = "logGroup"
},
Firehose = new FirehoseProperty {
Enabled = false,
// the properties below are optional
DeliveryStream = "deliveryStream"
},
S3 = new S3Property {
Enabled = false,
// the properties below are optional
Bucket = "bucket",
Prefix = "prefix"
}
}
},
OpenMonitoring = new OpenMonitoringProperty {
Prometheus = new PrometheusProperty {
JmxExporter = new JmxExporterProperty {
EnabledInBroker = false
},
NodeExporter = new NodeExporterProperty {
EnabledInBroker = false
}
}
},
Rebalancing = new RebalancingProperty {
Status = "status"
},
StorageMode = "storageMode",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
ZookeeperAccess = new ZookeeperAccessProperty {
Enabled = false
}
});
EncryptionInfo
Includes all encryption-related information.
public virtual object? EncryptionInfo { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnCluster.IEncryptionInfoProperty
EnhancedMonitoring
Specifies the level of monitoring for the MSK cluster.
public virtual string? EnhancedMonitoring { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
KafkaVersion
The version of Apache Kafka.
public virtual string KafkaVersion { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
LoggingInfo
Logging info details for the cluster.
public virtual object? LoggingInfo { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnCluster.ILoggingInfoProperty
NumberOfBrokerNodes
The number of broker nodes in the cluster.
public virtual double NumberOfBrokerNodes { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
OpenMonitoring
The settings for open monitoring.
public virtual object? OpenMonitoring { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnCluster.IOpenMonitoringProperty
Rebalancing
Creates a new MSK cluster.
public virtual object? Rebalancing { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnCluster.IRebalancingProperty
StorageMode
This controls storage mode for supported storage tiers.
public virtual string? StorageMode { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
TagsRaw
An arbitrary set of tags (key-value pairs) for the cluster.
public virtual IDictionary<string, string>? TagsRaw { get; set; }
Property Value
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
ZookeeperAccess
Creates a new MSK cluster.
public virtual object? ZookeeperAccess { get; set; }
Property Value
Remarks
Type union: either IResolvable or CfnCluster.IZookeeperAccessProperty
Methods
ArnForCluster(IClusterRef)
Creates a new MSK cluster.
public static string ArnForCluster(IClusterRef resource)
Parameters
- resource IClusterRef
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
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.MSK;
var cfnCluster = new CfnCluster(this, "MyCfnCluster", new CfnClusterProps {
BrokerNodeGroupInfo = new BrokerNodeGroupInfoProperty {
ClientSubnets = new [] { "clientSubnets" },
InstanceType = "instanceType",
// the properties below are optional
BrokerAzDistribution = "brokerAzDistribution",
ConnectivityInfo = new ConnectivityInfoProperty {
NetworkType = "networkType",
PublicAccess = new PublicAccessProperty {
Type = "type"
},
VpcConnectivity = new VpcConnectivityProperty {
ClientAuthentication = new VpcConnectivityClientAuthenticationProperty {
Sasl = new VpcConnectivitySaslProperty {
Iam = new VpcConnectivityIamProperty {
Enabled = false
},
Scram = new VpcConnectivityScramProperty {
Enabled = false
}
},
Tls = new VpcConnectivityTlsProperty {
Enabled = false
}
}
}
},
SecurityGroups = new [] { "securityGroups" },
StorageInfo = new StorageInfoProperty {
EbsStorageInfo = new EBSStorageInfoProperty {
ProvisionedThroughput = new ProvisionedThroughputProperty {
Enabled = false,
VolumeThroughput = 123
},
VolumeSize = 123
}
}
},
ClusterName = "clusterName",
KafkaVersion = "kafkaVersion",
NumberOfBrokerNodes = 123,
// the properties below are optional
ClientAuthentication = new ClientAuthenticationProperty {
Sasl = new SaslProperty {
Iam = new IamProperty {
Enabled = false
},
Scram = new ScramProperty {
Enabled = false
}
},
Tls = new TlsProperty {
CertificateAuthorityArnList = new [] { "certificateAuthorityArnList" },
Enabled = false
},
Unauthenticated = new UnauthenticatedProperty {
Enabled = false
}
},
ConfigurationInfo = new ConfigurationInfoProperty {
Arn = "arn",
Revision = 123
},
CurrentVersion = "currentVersion",
EncryptionInfo = new EncryptionInfoProperty {
EncryptionAtRest = new EncryptionAtRestProperty {
DataVolumeKmsKeyId = "dataVolumeKmsKeyId"
},
EncryptionInTransit = new EncryptionInTransitProperty {
ClientBroker = "clientBroker",
InCluster = false
}
},
EnhancedMonitoring = "enhancedMonitoring",
LoggingInfo = new LoggingInfoProperty {
BrokerLogs = new BrokerLogsProperty {
CloudWatchLogs = new CloudWatchLogsProperty {
Enabled = false,
// the properties below are optional
LogGroup = "logGroup"
},
Firehose = new FirehoseProperty {
Enabled = false,
// the properties below are optional
DeliveryStream = "deliveryStream"
},
S3 = new S3Property {
Enabled = false,
// the properties below are optional
Bucket = "bucket",
Prefix = "prefix"
}
},
// the properties below are optional
AuthorizerLogs = new AuthorizerLogsProperty {
CloudWatchLogs = new CloudWatchLogsProperty {
Enabled = false,
// the properties below are optional
LogGroup = "logGroup"
},
Firehose = new FirehoseProperty {
Enabled = false,
// the properties below are optional
DeliveryStream = "deliveryStream"
},
S3 = new S3Property {
Enabled = false,
// the properties below are optional
Bucket = "bucket",
Prefix = "prefix"
}
}
},
OpenMonitoring = new OpenMonitoringProperty {
Prometheus = new PrometheusProperty {
JmxExporter = new JmxExporterProperty {
EnabledInBroker = false
},
NodeExporter = new NodeExporterProperty {
EnabledInBroker = false
}
}
},
Rebalancing = new RebalancingProperty {
Status = "status"
},
StorageMode = "storageMode",
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
ZookeeperAccess = new ZookeeperAccessProperty {
Enabled = false
}
});
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
IsCfnCluster(object)
Checks whether the given object is a CfnCluster.
public static bool IsCfnCluster(object x)
Parameters
- x object
Returns
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated
RenderProperties(IDictionary<string, object>)
Creates a new MSK cluster.
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props IDictionary<string, object>
Returns
Overrides
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-cluster.html
CloudformationResource: AWS::MSK::Cluster
ExampleMetadata: fixture=_generated