AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the Amazon Managed Streaming for Apache Kafka (MSK) CreateCluster API operation.

Syntax

New-MSKCluster
-ClusterName <String>
-ConfigurationInfo_Arn <String>
-BrokerNodeGroupInfo <BrokerNodeGroupInfo>
-Tls_CertificateAuthorityArnList <String[]>
-EncryptionInTransit_ClientBroker <ClientBroker>
-EncryptionAtRest_DataVolumeKMSKeyId <String>
-JmxExporter_EnabledInBroker <Boolean>
-NodeExporter_EnabledInBroker <Boolean>
-EnhancedMonitoring <EnhancedMonitoring>
-EncryptionInTransit_InCluster <Boolean>
-KafkaVersion <String>
-NumberOfBrokerNode <Int32>
-ConfigurationInfo_Revision <Int64>
-Tag <Hashtable>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Creates a new MSK cluster.

Parameters

-BrokerNodeGroupInfo <BrokerNodeGroupInfo>
Information about the broker nodes in the cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterName <String>
The name of the cluster.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-ConfigurationInfo_Arn <String>
ARN of the configuration to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ConfigurationInfo_Revision <Int64>
The revision of the configuration to use.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-EncryptionAtRest_DataVolumeKMSKeyId <String>
The ARN of the AWS KMS key for encrypting data at rest. If you don't specify a KMS key, MSK creates one for you and uses it.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionInfo_EncryptionAtRest_DataVolumeKMSKeyId
-EncryptionInTransit_ClientBroker <ClientBroker>
Indicates the encryption setting for data in transit between clients and brokers. The following are the possible values. TLS means that client-broker communication is enabled with TLS only. TLS_PLAINTEXT means that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data. PLAINTEXT means that client-broker communication is enabled in plaintext only.The default value is TLS_PLAINTEXT.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionInfo_EncryptionInTransit_ClientBroker
-EncryptionInTransit_InCluster <Boolean>
When set to true, it indicates that data communication among the broker nodes of the cluster is encrypted. When set to false, the communication happens in plaintext.The default value is true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesEncryptionInfo_EncryptionInTransit_InCluster
-EnhancedMonitoring <EnhancedMonitoring>
Specifies the level of monitoring for the MSK cluster. The possible values are DEFAULT, PER_BROKER, and PER_TOPIC_PER_BROKER.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-JmxExporter_EnabledInBroker <Boolean>
Indicates whether you want to enable or disable the JMX Exporter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenMonitoring_Prometheus_JmxExporter_EnabledInBroker
-KafkaVersion <String>
The version of Apache Kafka.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-NodeExporter_EnabledInBroker <Boolean>
Indicates whether you want to enable or disable the Node Exporter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesOpenMonitoring_Prometheus_NodeExporter_EnabledInBroker
-NumberOfBrokerNode <Int32>
The number of broker nodes in the cluster.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesNumberOfBrokerNodes
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the ClusterName parameter. The -PassThru parameter is deprecated, use -Select '^ClusterName' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is '*'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.Kafka.Model.CreateClusterResponse). Specifying the name of a property of type Amazon.Kafka.Model.CreateClusterResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Tag <Hashtable>
Create tags when creating the cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesTags
-Tls_CertificateAuthorityArnList <String[]>
List of ACM Certificate Authority ARNs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClientAuthentication_Tls_CertificateAuthorityArnList

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns an Amazon.Kafka.Model.CreateClusterResponse object containing multiple properties. The object can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z