1. Packages
  2. AWS Native
  3. API Docs
  4. msk
  5. Cluster

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

aws-native.msk.Cluster

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi

    Resource Type definition for AWS::MSK::Cluster

    Create Cluster Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Cluster(name: string, args: ClusterArgs, opts?: CustomResourceOptions);
    @overload
    def Cluster(resource_name: str,
                args: ClusterArgs,
                opts: Optional[ResourceOptions] = None)
    
    @overload
    def Cluster(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                broker_node_group_info: Optional[ClusterBrokerNodeGroupInfoArgs] = None,
                number_of_broker_nodes: Optional[int] = None,
                kafka_version: Optional[str] = None,
                configuration_info: Optional[ClusterConfigurationInfoArgs] = None,
                current_version: Optional[str] = None,
                encryption_info: Optional[ClusterEncryptionInfoArgs] = None,
                enhanced_monitoring: Optional[ClusterEnhancedMonitoring] = None,
                cluster_name: Optional[str] = None,
                logging_info: Optional[ClusterLoggingInfoArgs] = None,
                client_authentication: Optional[ClusterClientAuthenticationArgs] = None,
                open_monitoring: Optional[ClusterOpenMonitoringArgs] = None,
                storage_mode: Optional[ClusterStorageMode] = None,
                tags: Optional[Mapping[str, str]] = None)
    func NewCluster(ctx *Context, name string, args ClusterArgs, opts ...ResourceOption) (*Cluster, error)
    public Cluster(string name, ClusterArgs args, CustomResourceOptions? opts = null)
    public Cluster(String name, ClusterArgs args)
    public Cluster(String name, ClusterArgs args, CustomResourceOptions options)
    
    type: aws-native:msk:Cluster
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args ClusterArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Cluster Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Cluster resource accepts the following input properties:

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Cluster resource produces the following output properties:

    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    Arn string
    Id string
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.
    arn string
    id string
    The provider-assigned unique ID for this managed resource.
    arn str
    id str
    The provider-assigned unique ID for this managed resource.
    arn String
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    ClusterBrokerLogs, ClusterBrokerLogsArgs

    ClusterBrokerNodeGroupInfo, ClusterBrokerNodeGroupInfoArgs

    ClientSubnets List<string>
    InstanceType string
    The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.
    BrokerAzDistribution string
    ConnectivityInfo Pulumi.AwsNative.Msk.Inputs.ClusterConnectivityInfo
    SecurityGroups List<string>
    StorageInfo Pulumi.AwsNative.Msk.Inputs.ClusterStorageInfo
    ClientSubnets []string
    InstanceType string
    The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.
    BrokerAzDistribution string
    ConnectivityInfo ClusterConnectivityInfo
    SecurityGroups []string
    StorageInfo ClusterStorageInfo
    clientSubnets List<String>
    instanceType String
    The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.
    brokerAzDistribution String
    connectivityInfo ClusterConnectivityInfo
    securityGroups List<String>
    storageInfo ClusterStorageInfo
    clientSubnets string[]
    instanceType string
    The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.
    brokerAzDistribution string
    connectivityInfo ClusterConnectivityInfo
    securityGroups string[]
    storageInfo ClusterStorageInfo
    client_subnets Sequence[str]
    instance_type str
    The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.
    broker_az_distribution str
    connectivity_info ClusterConnectivityInfo
    security_groups Sequence[str]
    storage_info ClusterStorageInfo
    clientSubnets List<String>
    instanceType String
    The type of Amazon EC2 instances to use for brokers. The following instance types are allowed: kafka.m5.large, kafka.m5.xlarge, kafka.m5.2xlarge, kafka.m5.4xlarge, kafka.m5.8xlarge, kafka.m5.12xlarge, kafka.m5.16xlarge, kafka.m5.24xlarge, and kafka.t3.small.
    brokerAzDistribution String
    connectivityInfo Property Map
    securityGroups List<String>
    storageInfo Property Map

    ClusterClientAuthentication, ClusterClientAuthenticationArgs

    ClusterCloudWatchLogs, ClusterCloudWatchLogsArgs

    Enabled bool
    LogGroup string
    Enabled bool
    LogGroup string
    enabled Boolean
    logGroup String
    enabled boolean
    logGroup string
    enabled Boolean
    logGroup String

    ClusterConfigurationInfo, ClusterConfigurationInfoArgs

    Arn string
    Revision int
    Arn string
    Revision int
    arn String
    revision Integer
    arn string
    revision number
    arn str
    revision int
    arn String
    revision Number

    ClusterConnectivityInfo, ClusterConnectivityInfoArgs

    ClusterEbsStorageInfo, ClusterEbsStorageInfoArgs

    ClusterEncryptionAtRest, ClusterEncryptionAtRestArgs

    ClusterEncryptionInTransit, ClusterEncryptionInTransitArgs

    ClusterEncryptionInTransitClientBroker, ClusterEncryptionInTransitClientBrokerArgs

    Tls
    TLS
    TlsPlaintext
    TLS_PLAINTEXT
    Plaintext
    PLAINTEXT
    ClusterEncryptionInTransitClientBrokerTls
    TLS
    ClusterEncryptionInTransitClientBrokerTlsPlaintext
    TLS_PLAINTEXT
    ClusterEncryptionInTransitClientBrokerPlaintext
    PLAINTEXT
    Tls
    TLS
    TlsPlaintext
    TLS_PLAINTEXT
    Plaintext
    PLAINTEXT
    Tls
    TLS
    TlsPlaintext
    TLS_PLAINTEXT
    Plaintext
    PLAINTEXT
    TLS
    TLS
    TLS_PLAINTEXT
    TLS_PLAINTEXT
    PLAINTEXT
    PLAINTEXT
    "TLS"
    TLS
    "TLS_PLAINTEXT"
    TLS_PLAINTEXT
    "PLAINTEXT"
    PLAINTEXT

    ClusterEncryptionInfo, ClusterEncryptionInfoArgs

    ClusterEnhancedMonitoring, ClusterEnhancedMonitoringArgs

    Default
    DEFAULT
    PerBroker
    PER_BROKER
    PerTopicPerBroker
    PER_TOPIC_PER_BROKER
    PerTopicPerPartition
    PER_TOPIC_PER_PARTITION
    ClusterEnhancedMonitoringDefault
    DEFAULT
    ClusterEnhancedMonitoringPerBroker
    PER_BROKER
    ClusterEnhancedMonitoringPerTopicPerBroker
    PER_TOPIC_PER_BROKER
    ClusterEnhancedMonitoringPerTopicPerPartition
    PER_TOPIC_PER_PARTITION
    Default
    DEFAULT
    PerBroker
    PER_BROKER
    PerTopicPerBroker
    PER_TOPIC_PER_BROKER
    PerTopicPerPartition
    PER_TOPIC_PER_PARTITION
    Default
    DEFAULT
    PerBroker
    PER_BROKER
    PerTopicPerBroker
    PER_TOPIC_PER_BROKER
    PerTopicPerPartition
    PER_TOPIC_PER_PARTITION
    DEFAULT
    DEFAULT
    PER_BROKER
    PER_BROKER
    PER_TOPIC_PER_BROKER
    PER_TOPIC_PER_BROKER
    PER_TOPIC_PER_PARTITION
    PER_TOPIC_PER_PARTITION
    "DEFAULT"
    DEFAULT
    "PER_BROKER"
    PER_BROKER
    "PER_TOPIC_PER_BROKER"
    PER_TOPIC_PER_BROKER
    "PER_TOPIC_PER_PARTITION"
    PER_TOPIC_PER_PARTITION

    ClusterFirehose, ClusterFirehoseArgs

    enabled Boolean
    deliveryStream String
    enabled boolean
    deliveryStream string
    enabled Boolean
    deliveryStream String

    ClusterIam, ClusterIamArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterJmxExporter, ClusterJmxExporterArgs

    ClusterLoggingInfo, ClusterLoggingInfoArgs

    ClusterNodeExporter, ClusterNodeExporterArgs

    ClusterOpenMonitoring, ClusterOpenMonitoringArgs

    ClusterPrometheus, ClusterPrometheusArgs

    ClusterProvisionedThroughput, ClusterProvisionedThroughputArgs

    enabled Boolean
    volumeThroughput Integer

    ClusterPublicAccess, ClusterPublicAccessArgs

    Type string
    Type string
    type String
    type string
    type str
    type String

    ClusterS3, ClusterS3Args

    Enabled bool
    Bucket string
    Prefix string
    Enabled bool
    Bucket string
    Prefix string
    enabled Boolean
    bucket String
    prefix String
    enabled boolean
    bucket string
    prefix string
    enabled bool
    bucket str
    prefix str
    enabled Boolean
    bucket String
    prefix String

    ClusterSasl, ClusterSaslArgs

    ClusterScram, ClusterScramArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterStorageInfo, ClusterStorageInfoArgs

    ClusterStorageMode, ClusterStorageModeArgs

    Local
    LOCAL
    Tiered
    TIERED
    ClusterStorageModeLocal
    LOCAL
    ClusterStorageModeTiered
    TIERED
    Local
    LOCAL
    Tiered
    TIERED
    Local
    LOCAL
    Tiered
    TIERED
    LOCAL
    LOCAL
    TIERED
    TIERED
    "LOCAL"
    LOCAL
    "TIERED"
    TIERED

    ClusterTls, ClusterTlsArgs

    ClusterUnauthenticated, ClusterUnauthenticatedArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterVpcConnectivity, ClusterVpcConnectivityArgs

    ClusterVpcConnectivityClientAuthentication, ClusterVpcConnectivityClientAuthenticationArgs

    ClusterVpcConnectivityIam, ClusterVpcConnectivityIamArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterVpcConnectivitySasl, ClusterVpcConnectivitySaslArgs

    ClusterVpcConnectivityScram, ClusterVpcConnectivityScramArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    ClusterVpcConnectivityTls, ClusterVpcConnectivityTlsArgs

    Enabled bool
    Enabled bool
    enabled Boolean
    enabled boolean
    enabled bool
    enabled Boolean

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Native v0.126.0 published on Monday, Sep 30, 2024 by Pulumi