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) UpdateSecurity API operation.

Syntax

Update-MSKSecurity
-ClusterArn <String>
-Tls_CertificateAuthorityArnList <String[]>
-EncryptionInTransit_ClientBroker <ClientBroker>
-CurrentVersion <String>
-EncryptionAtRest_DataVolumeKMSKeyId <String>
-Iam_Enabled <Boolean>
-Scram_Enabled <Boolean>
-Tls_Enabled <Boolean>
-Unauthenticated_Enabled <Boolean>
-EncryptionInTransit_InCluster <Boolean>
-Select <String>
-Force <SwitchParameter>
-ClientConfig <AmazonKafkaConfig>

Description

Updates the security settings for the cluster. You can use this operation to specify encryption and authentication on existing clusters.

Parameters

-ClientConfig <AmazonKafkaConfig>
Amazon.PowerShell.Cmdlets.MSK.AmazonKafkaClientCmdlet.ClientConfig
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-ClusterArn <String>
The Amazon Resource Name (ARN) that uniquely identifies the cluster.
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-CurrentVersion <String>
The version of the MSK cluster to update. Cluster versions aren't simple numbers. You can describe an MSK cluster to find its version. When this update operation is successful, it generates a new cluster version.
Required?True
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
-Force <SwitchParameter>
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)
-Iam_Enabled <Boolean>
Indicates whether IAM access control is enabled.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClientAuthentication_Sasl_Iam_Enabled
-Scram_Enabled <Boolean>
SASL/SCRAM authentication is enabled or not.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClientAuthentication_Sasl_Scram_Enabled
-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.UpdateSecurityResponse). Specifying the name of a property of type Amazon.Kafka.Model.UpdateSecurityResponse 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)
-Tls_CertificateAuthorityArnList <String[]>
List of ACM Certificate Authority ARNs. Starting with version 4 of the SDK this property will default to null. If no data for this property is returned from the service the property will also be null. This was changed to improve performance and allow the SDK and caller to distinguish between a property not set or a property being empty to clear out a value. To retain the previous SDK behavior set the AWSConfigs.InitializeCollections static property to true.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClientAuthentication_Tls_CertificateAuthorityArnList
-Tls_Enabled <Boolean>
Specifies whether you want to turn on or turn off TLS authentication.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClientAuthentication_Tls_Enabled
-Unauthenticated_Enabled <Boolean>
Specifies whether you want to turn on or turn off unauthenticated traffic to your cluster.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesClientAuthentication_Unauthenticated_Enabled

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

Amazon.Kafka.Model.UpdateSecurityResponse
This cmdlet returns an Amazon.Kafka.Model.UpdateSecurityResponse object containing multiple properties.
Developer Guide
Service API Reference
AWS Tools for PowerShell User Guide

Supported Version

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