Class CfnReplicator
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.CfnReplicator
- All Implemented Interfaces:
IInspectable
,ITaggableV2
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
date="2024-05-08T21:35:10.052Z")
@Stability(Stable)
public class CfnReplicator
extends CfnResource
implements IInspectable, ITaggableV2
Resource Type definition for AWS::MSK::Replicator.
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.*; CfnReplicator cfnReplicator = CfnReplicator.Builder.create(this, "MyCfnReplicator") .kafkaClusters(List.of(KafkaClusterProperty.builder() .amazonMskCluster(AmazonMskClusterProperty.builder() .mskClusterArn("mskClusterArn") .build()) .vpcConfig(KafkaClusterClientVpcConfigProperty.builder() .subnetIds(List.of("subnetIds")) // the properties below are optional .securityGroupIds(List.of("securityGroupIds")) .build()) .build())) .replicationInfoList(List.of(ReplicationInfoProperty.builder() .consumerGroupReplication(ConsumerGroupReplicationProperty.builder() .consumerGroupsToReplicate(List.of("consumerGroupsToReplicate")) // the properties below are optional .consumerGroupsToExclude(List.of("consumerGroupsToExclude")) .detectAndCopyNewConsumerGroups(false) .synchroniseConsumerGroupOffsets(false) .build()) .sourceKafkaClusterArn("sourceKafkaClusterArn") .targetCompressionType("targetCompressionType") .targetKafkaClusterArn("targetKafkaClusterArn") .topicReplication(TopicReplicationProperty.builder() .topicsToReplicate(List.of("topicsToReplicate")) // the properties below are optional .copyAccessControlListsForTopics(false) .copyTopicConfigurations(false) .detectAndCopyNewTopics(false) .startingPosition(ReplicationStartingPositionProperty.builder() .type("type") .build()) .topicsToExclude(List.of("topicsToExclude")) .build()) .build())) .replicatorName("replicatorName") .serviceExecutionRoleArn("serviceExecutionRoleArn") // the properties below are optional .currentVersion("currentVersion") .description("description") .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Details of an Amazon MSK cluster.static final class
A fluent builder forCfnReplicator
.static interface
Configuration relating to consumer group replication.static interface
Details of an Amazon VPC which has network connectivity to the Kafka cluster.static interface
Details of a Kafka cluster for replication.static interface
Specifies configuration for replication between a source and target Kafka cluster.static interface
Configuration for specifying the position in the topics to start replicating from.static interface
Example:Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
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
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggableV2
ITaggableV2.Jsii$Default, ITaggableV2.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnReplicator
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnReplicator
(software.amazon.jsii.JsiiObjectRef objRef) CfnReplicator
(software.constructs.Construct scope, String id, CfnReplicatorProps props) -
Method Summary
Modifier and TypeMethodDescriptionAmazon Resource Name (ARN) for the created replicator.Tag Manager which manages the tags for this resource.The current version of the MSK replicator.A summary description of the replicator.Specifies a list of Kafka clusters which are targets of the replicator.A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.The name of the replicator.The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.getTags()
A collection of tags associated with a resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setCurrentVersion
(String value) The current version of the MSK replicator.void
setDescription
(String value) A summary description of the replicator.void
setKafkaClusters
(List<Object> value) Specifies a list of Kafka clusters which are targets of the replicator.void
setKafkaClusters
(IResolvable value) Specifies a list of Kafka clusters which are targets of the replicator.void
setReplicationInfoList
(List<Object> value) A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.void
A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.void
setReplicatorName
(String value) The name of the replicator.void
setServiceExecutionRoleArn
(String value) The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.void
A collection of tags associated with a resource.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.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnReplicator
protected CfnReplicator(software.amazon.jsii.JsiiObjectRef objRef) -
CfnReplicator
protected CfnReplicator(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnReplicator
@Stability(Stable) public CfnReplicator(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnReplicatorProps 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
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- 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 classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrReplicatorArn
Amazon Resource Name (ARN) for the created replicator. -
getCdkTagManager
Tag Manager which manages the tags for this resource.- Specified by:
getCdkTagManager
in interfaceITaggableV2
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getKafkaClusters
Specifies a list of Kafka clusters which are targets of the replicator. -
setKafkaClusters
Specifies a list of Kafka clusters which are targets of the replicator. -
setKafkaClusters
Specifies a list of Kafka clusters which are targets of the replicator. -
getReplicationInfoList
A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. -
setReplicationInfoList
A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. -
setReplicationInfoList
A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. -
getReplicatorName
The name of the replicator. -
setReplicatorName
The name of the replicator. -
getServiceExecutionRoleArn
The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources. -
setServiceExecutionRoleArn
The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources. -
getCurrentVersion
The current version of the MSK replicator. -
setCurrentVersion
The current version of the MSK replicator. -
getDescription
A summary description of the replicator. -
setDescription
A summary description of the replicator. -
getTags
A collection of tags associated with a resource. -
setTags
A collection of tags associated with a resource.
-