Package software.amazon.awscdk.services.msk

Class CfnBatchScramSecret

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.msk.CfnBatchScramSecret

All Implemented Interfaces:

IInspectable, IBatchScramSecretRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)",
           date="2025-10-24T13:34:42.400Z")
@Stability(Stable)
public class CfnBatchScramSecret
extends CfnResource
implements IInspectable, IBatchScramSecretRef

Represents a secret stored in the AWS Secrets Manager that can be used to authenticate with a cluster using a user name and a password.

Example:

 // 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.*;
 CfnBatchScramSecret cfnBatchScramSecret = CfnBatchScramSecret.Builder.create(this, "MyCfnBatchScramSecret")
         .clusterArn("clusterArn")
         // the properties below are optional
         .secretArnList(List.of("secretArnList"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-batchscramsecret.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CfnBatchScramSecret.Builder	A fluent builder for CfnBatchScramSecret.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.services.msk.IBatchScramSecretRef

IBatchScramSecretRef.Jsii$Default, IBatchScramSecretRef.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Field Summary

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	CfnBatchScramSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBatchScramSecret(software.amazon.jsii.JsiiObjectRef objRef)
	CfnBatchScramSecret(software.constructs.Construct scope, String id, CfnBatchScramSecretProps props)

Method Summary

Modifier and Type	Method	Description
BatchScramSecretReference	getBatchScramSecretRef()	A reference to a BatchScramSecret resource.
protected Map<String,Object>	getCfnProperties()
String	getClusterArn()	The Amazon Resource Name (ARN) that uniquely identifies the cluster.
List<String>	getSecretArnList()	List of Amazon Resource Name (ARN)s of Secrets Manager secrets.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setClusterArn(String value)	The Amazon Resource Name (ARN) that uniquely identifies the cluster.
void	setSecretArnList(List<String> value)	List of Amazon Resource Name (ARN)s of Secrets Manager secrets.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.constructs.IConstruct

getNode

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Details

CFN_RESOURCE_TYPE_NAME

@Stability(Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Details

CfnBatchScramSecret

protected CfnBatchScramSecret(software.amazon.jsii.JsiiObjectRef objRef)

CfnBatchScramSecret

protected CfnBatchScramSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnBatchScramSecret

@Stability(Stable)
public CfnBatchScramSecret(@NotNull
 software.constructs.Construct scope,
 @NotNull
 String id,
 @NotNull
 CfnBatchScramSecretProps props)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

props - Resource properties. This parameter is required.

Method Details

inspect

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> renderProperties(@NotNull
 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getBatchScramSecretRef

@Stability(Stable)
@NotNull
public BatchScramSecretReference getBatchScramSecretRef()

A reference to a BatchScramSecret resource.

Specified by:

getBatchScramSecretRef in interface IBatchScramSecretRef

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClusterArn

@Stability(Stable)
@NotNull
public String getClusterArn()

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

setClusterArn

@Stability(Stable)
public void setClusterArn(@NotNull
 String value)

The Amazon Resource Name (ARN) that uniquely identifies the cluster.

getSecretArnList

@Stability(Stable)
@Nullable
public List<String> getSecretArnList()

List of Amazon Resource Name (ARN)s of Secrets Manager secrets.

setSecretArnList

@Stability(Stable)
public void setSecretArnList(@Nullable
 List<String> value)

List of Amazon Resource Name (ARN)s of Secrets Manager secrets.