software.amazon.awscdk.services.msk

Class CfnConfiguration

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.CfnConfiguration

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.988Z")
 @Stability(value=Stable)
public class CfnConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::MSK::Configuration`.

Creates a new MSK configuration.

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.*;
 CfnConfiguration cfnConfiguration = CfnConfiguration.Builder.create(this, "MyCfnConfiguration")
         .name("name")
         .serverProperties("serverProperties")
         // the properties below are optional
         .description("description")
         .kafkaVersionsList(List.of("kafkaVersionsList"))
         .build();
 

Nested Class Summary

Nested Classes

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

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
	CfnConfiguration(software.constructs.Construct scope, String id, CfnConfigurationProps props) Create a new `AWS::MSK::Configuration`.
protected	CfnConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The ARN of the configuration.
protected Map<String,Object>	getCfnProperties()
String	getDescription() The description of the configuration.
List<String>	getKafkaVersionsList() A list of the versions of Apache Kafka with which you can use this MSK configuration.
String	getName() The name of the configuration.
String	getServerProperties() Contents of the server.properties file.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDescription(String value) The description of the configuration.
void	setKafkaVersionsList(List<String> value) A list of the versions of Apache Kafka with which you can use this MSK configuration.
void	setName(String value) The name of the configuration.
void	setServerProperties(String value) Contents of the server.properties file.

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

CfnConfiguration

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

CfnConfiguration

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

CfnConfiguration

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

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

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.

getAttrArn

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

The ARN of the configuration.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getName

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

The name of the configuration.

Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".

setName

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

The name of the configuration.

Configuration names are strings that match the regex "^[0-9A-Za-z][0-9A-Za-z-]{0,}$".

getServerProperties

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

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the CLI, the contents of server.properties can be in plaintext.

setServerProperties

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

Contents of the server.properties file. When using the API, you must ensure that the contents of the file are base64 encoded. When using the console, the SDK, or the CLI, the contents of server.properties can be in plaintext.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

The description of the configuration.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

The description of the configuration.

getKafkaVersionsList

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

A list of the versions of Apache Kafka with which you can use this MSK configuration.

You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this list.

setKafkaVersionsList

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

A list of the versions of Apache Kafka with which you can use this MSK configuration.

You can use this configuration for an MSK cluster only if the Apache Kafka version specified for the cluster appears in this list.