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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:40.966Z")
 @Stability(value=Stable)
public class CfnBatchScramSecret
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MSK::BatchScramSecret`.

Represents a secret stored in the Amazon 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static 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.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

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

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBatchScramSecret(software.constructs.Construct scope, String id, CfnBatchScramSecretProps props) Create a new `AWS::MSK::BatchScramSecret`.
protected	CfnBatchScramSecret(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnBatchScramSecret(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
String	getClusterArn() The Amazon Resource Name (ARN) of the MSK cluster.
List<String>	getSecretArnList() A list of Amazon Secrets Manager secret ARNs.
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) of the MSK cluster.
void	setSecretArnList(List<String> value) A list of Amazon Secrets Manager secret ARNs.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, 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.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnBatchScramSecret

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

CfnBatchScramSecret

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

CfnBatchScramSecret

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

Create a new `AWS::MSK::BatchScramSecret`.

Parameters:

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

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getClusterArn

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

The Amazon Resource Name (ARN) of the MSK cluster.

setClusterArn

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

The Amazon Resource Name (ARN) of the MSK cluster.

getSecretArnList

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

A list of Amazon Secrets Manager secret ARNs.

setSecretArnList

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

A list of Amazon Secrets Manager secret ARNs.