Skip to content
v2.277.0

EncryptionInTransitProperty Struct ​

The settings for encrypting data in transit.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_msk as msk } from 'aws-cdk-lib';
const encryptionInTransitProperty: msk.CfnCluster.EncryptionInTransitProperty = {
  clientBroker: 'clientBroker',
  inCluster: false,
};
python
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_msk as msk

encryption_in_transit_property = msk.CfnCluster.EncryptionInTransitProperty(
    client_broker="clientBroker",
    in_cluster=False
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.msk.*;

EncryptionInTransitProperty encryptionInTransitProperty = EncryptionInTransitProperty.builder()
        .clientBroker("clientBroker")
        .inCluster(false)
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// 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 encryptionInTransitProperty = new EncryptionInTransitProperty {
    ClientBroker = "clientBroker",
    InCluster = false
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

encryptionInTransitProperty := &EncryptionInTransitProperty{
	ClientBroker: jsii.String("clientBroker"),
	InCluster: jsii.Boolean(false),
}

Properties ​

clientBrokeroptionalstringclient_brokeroptionalstrclientBrokeroptionalStringClientBrokeroptionalstringClientBrokeroptional*string #
Indicates the encryption setting for data in transit between clients and brokers.
notes

You must set it to one of the following values.

  • TLS : Indicates that client-broker communication is enabled with TLS only.
  • TLS_PLAINTEXT : Indicates that client-broker communication is enabled for both TLS-encrypted, as well as plaintext data.
  • PLAINTEXT : Indicates that client-broker communication is enabled in plaintext only.

The default value is TLS .

inClusteroptionalboolean | IResolvablein_clusteroptionaltyping.Union[bool, IResolvable]inClusteroptionalBooleanInClusteroptionalboolInClusteroptionalinterface{} #
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.