software.amazon.awscdk.services.msk

Class CfnBatchScramSecret

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.msk.CfnBatchScramSecret

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)",
           date="2022-06-22T23:27:57.813Z")
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnBatchScramSecret(Construct scope, java.lang.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 java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getClusterArn() The Amazon Resource Name (ARN) of the MSK cluster.
java.util.List<java.lang.String>	getSecretArnList() A list of Amazon Secrets Manager secret ARNs.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setClusterArn(java.lang.String value) The Amazon Resource Name (ARN) of the MSK cluster.
void	setSecretArnList(java.util.List<java.lang.String> value) A list of Amazon Secrets Manager secret ARNs.

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnBatchScramSecret(Construct scope,
                           java.lang.String id,
                           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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getClusterArn

public java.lang.String getClusterArn()

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

setClusterArn

public void setClusterArn(java.lang.String value)

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

getSecretArnList

public java.util.List<java.lang.String> getSecretArnList()

A list of Amazon Secrets Manager secret ARNs.

setSecretArnList

public void setSecretArnList(java.util.List<java.lang.String> value)

A list of Amazon Secrets Manager secret ARNs.