Class CfnReplicator
Resource Type definition for AWS::MSK::Replicator.
Inherited Members
Namespace: Amazon.CDK.AWS.MSK
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnReplicator : CfnResource, IInspectable, ITaggableV2
Syntax (vb)
Public Class CfnReplicator
Inherits CfnResource
Implements IInspectable, ITaggableV2
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-msk-replicator.html
CloudformationResource: AWS::MSK::Replicator
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.MSK;
var cfnReplicator = new CfnReplicator(this, "MyCfnReplicator", new CfnReplicatorProps {
KafkaClusters = new [] { new KafkaClusterProperty {
AmazonMskCluster = new AmazonMskClusterProperty {
MskClusterArn = "mskClusterArn"
},
VpcConfig = new KafkaClusterClientVpcConfigProperty {
SubnetIds = new [] { "subnetIds" },
// the properties below are optional
SecurityGroupIds = new [] { "securityGroupIds" }
}
} },
ReplicationInfoList = new [] { new ReplicationInfoProperty {
ConsumerGroupReplication = new ConsumerGroupReplicationProperty {
ConsumerGroupsToReplicate = new [] { "consumerGroupsToReplicate" },
// the properties below are optional
ConsumerGroupsToExclude = new [] { "consumerGroupsToExclude" },
DetectAndCopyNewConsumerGroups = false,
SynchroniseConsumerGroupOffsets = false
},
SourceKafkaClusterArn = "sourceKafkaClusterArn",
TargetCompressionType = "targetCompressionType",
TargetKafkaClusterArn = "targetKafkaClusterArn",
TopicReplication = new TopicReplicationProperty {
TopicsToReplicate = new [] { "topicsToReplicate" },
// the properties below are optional
CopyAccessControlListsForTopics = false,
CopyTopicConfigurations = false,
DetectAndCopyNewTopics = false,
StartingPosition = new ReplicationStartingPositionProperty {
Type = "type"
},
TopicsToExclude = new [] { "topicsToExclude" }
}
} },
ReplicatorName = "replicatorName",
ServiceExecutionRoleArn = "serviceExecutionRoleArn",
// the properties below are optional
CurrentVersion = "currentVersion",
Description = "description",
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
});
Synopsis
Constructors
CfnReplicator(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnReplicator(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnReplicator(Construct, String, ICfnReplicatorProps) |
Properties
AttrReplicatorArn | Amazon Resource Name (ARN) for the created replicator. |
CdkTagManager | Tag Manager which manages the tags for this resource. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
CurrentVersion | The current version of the MSK replicator. |
Description | A summary description of the replicator. |
KafkaClusters | Specifies a list of Kafka clusters which are targets of the replicator. |
ReplicationInfoList | A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow. |
ReplicatorName | The name of the replicator. |
ServiceExecutionRoleArn | The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources. |
Tags | A collection of tags associated with a resource. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnReplicator(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnReplicator(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnReplicator(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnReplicator(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnReplicator(Construct, String, ICfnReplicatorProps)
public CfnReplicator(Construct scope, string id, ICfnReplicatorProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnReplicatorProps
Resource properties.
Properties
AttrReplicatorArn
Amazon Resource Name (ARN) for the created replicator.
public virtual string AttrReplicatorArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: ReplicatorArn
CdkTagManager
Tag Manager which manages the tags for this resource.
public virtual TagManager CdkTagManager { get; }
Property Value
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
CurrentVersion
The current version of the MSK replicator.
public virtual string CurrentVersion { get; set; }
Property Value
System.String
Description
A summary description of the replicator.
public virtual string Description { get; set; }
Property Value
System.String
KafkaClusters
Specifies a list of Kafka clusters which are targets of the replicator.
public virtual object KafkaClusters { get; set; }
Property Value
System.Object
ReplicationInfoList
A list of replication configurations, where each configuration targets a given source cluster to target cluster replication flow.
public virtual object ReplicationInfoList { get; set; }
Property Value
System.Object
ReplicatorName
The name of the replicator.
public virtual string ReplicatorName { get; set; }
Property Value
System.String
ServiceExecutionRoleArn
The Amazon Resource Name (ARN) of the IAM role used by the replicator to access external resources.
public virtual string ServiceExecutionRoleArn { get; set; }
Property Value
System.String
Tags
A collection of tags associated with a resource.
public virtual ICfnTag[] Tags { get; set; }
Property Value
ICfnTag[]
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>