Class: AWSCDK::KafkaConnect::CfnConnector

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSKafkaconnect::IConnectorRef
Defined in:
kafka_connect/cfn_connector.rb

Overview

Creates a connector using the specified properties.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnConnector

Create a new AWS::KafkaConnect::Connector.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::KafkaConnect::CfnConnectorProps) —

    Resource properties.



18
19
20
21
22
23
24
 
# File 'kafka_connect/cfn_connector.rb', line 18

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::KafkaConnect::CfnConnectorProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2Fma2Fjb25uZWN0LkNmbkNvbm5lY3RvclByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_connector(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'kafka_connect/cfn_connector.rb', line 85

def self.arn_for_connector(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19rYWZrYWNvbm5lY3QuSUNvbm5lY3RvclJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kafkaconnect.CfnConnector", "arnForConnector", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


192
193
194
 
# File 'kafka_connect/cfn_connector.rb', line 192

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_kafkaconnect.CfnConnector", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_connector(x) ⇒ Boolean

Checks whether the given object is a CfnConnector.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


94
95
96
97
 
# File 'kafka_connect/cfn_connector.rb', line 94

def self.is_cfn_connector(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_kafkaconnect.CfnConnector", "isCfnConnector", [x])
end

.jsii_overridable_methods ⇒ Object 



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
 
# File 'kafka_connect/cfn_connector.rb', line 26

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_connector_arn => { kind: :property, name: "attrConnectorArn", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :connector_ref => { kind: :property, name: "connectorRef", is_optional: false },
    :capacity => { kind: :property, name: "capacity", is_optional: false },
    :connector_configuration => { kind: :property, name: "connectorConfiguration", is_optional: false },
    :connector_name => { kind: :property, name: "connectorName", is_optional: false },
    :kafka_cluster => { kind: :property, name: "kafkaCluster", is_optional: false },
    :kafka_cluster_client_authentication => { kind: :property, name: "kafkaClusterClientAuthentication", is_optional: false },
    :kafka_cluster_encryption_in_transit => { kind: :property, name: "kafkaClusterEncryptionInTransit", is_optional: false },
    :kafka_connect_version => { kind: :property, name: "kafkaConnectVersion", is_optional: false },
    :plugins => { kind: :property, name: "plugins", is_optional: false },
    :service_execution_role_arn => { kind: :property, name: "serviceExecutionRoleArn", is_optional: false },
    :connector_description => { kind: :property, name: "connectorDescription", is_optional: true },
    :log_delivery => { kind: :property, name: "logDelivery", is_optional: true },
    :network_type => { kind: :property, name: "networkType", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :worker_configuration => { kind: :property, name: "workerConfiguration", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



428
429
430
431
 
# File 'kafka_connect/cfn_connector.rb', line 428

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



440
441
442
443
 
# File 'kafka_connect/cfn_connector.rb', line 440

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



450
451
452
453
 
# File 'kafka_connect/cfn_connector.rb', line 450

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



461
462
463
464
465
 
# File 'kafka_connect/cfn_connector.rb', line 461

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


518
519
520
521
522
 
# File 'kafka_connect/cfn_connector.rb', line 518

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



528
529
530
531
 
# File 'kafka_connect/cfn_connector.rb', line 528

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



540
541
542
543
544
 
# File 'kafka_connect/cfn_connector.rb', line 540

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



553
554
555
556
 
# File 'kafka_connect/cfn_connector.rb', line 553

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

See Also:



575
576
577
578
579
580
 
# File 'kafka_connect/cfn_connector.rb', line 575

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_connector_arn ⇒ String

The Amazon Resource Name (ARN) of the newly created connector.

Returns:

  • (String) 


199
200
201
 
# File 'kafka_connect/cfn_connector.rb', line 199

def attr_connector_arn()
  jsii_get_property("attrConnectorArn")
end

#capacity ⇒ AWSCDK::IResolvable, AWSCDK::KafkaConnect::CfnConnector::CapacityProperty

The connector's compute capacity settings.

Returns:



220
221
222
 
# File 'kafka_connect/cfn_connector.rb', line 220

def capacity()
  jsii_get_property("capacity")
end

#capacity=(value) ⇒ Object 



224
225
226
227
228
 
# File 'kafka_connect/cfn_connector.rb', line 224

def capacity=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KafkaConnect::CfnConnector::CapacityProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rYWZrYWNvbm5lY3QuQ2ZuQ29ubmVjdG9yLkNhcGFjaXR5UHJvcGVydHkifV19fQ==")), "capacity")
  jsii_set_property("capacity", value)
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



206
207
208
 
# File 'kafka_connect/cfn_connector.rb', line 206

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



145
146
147
 
# File 'kafka_connect/cfn_connector.rb', line 145

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


150
151
152
 
# File 'kafka_connect/cfn_connector.rb', line 150

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


584
585
586
587
 
# File 'kafka_connect/cfn_connector.rb', line 584

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


155
156
157
 
# File 'kafka_connect/cfn_connector.rb', line 155

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


162
163
164
 
# File 'kafka_connect/cfn_connector.rb', line 162

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#connector_configuration ⇒ AWSCDK::IResolvable, Hash{String => String}

The configuration of the connector.

Returns:



233
234
235
 
# File 'kafka_connect/cfn_connector.rb', line 233

def connector_configuration()
  jsii_get_property("connectorConfiguration")
end

#connector_configuration=(value) ⇒ Object 



237
238
239
240
 
# File 'kafka_connect/cfn_connector.rb', line 237

def connector_configuration=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsicHJpbWl0aXZlIjoic3RyaW5nIn0sImtpbmQiOiJtYXAifX1dfX0=")), "connectorConfiguration")
  jsii_set_property("connectorConfiguration", value)
end

#connector_description ⇒ String?

The description of the connector.

Returns:

  • (String, nil) 


332
333
334
 
# File 'kafka_connect/cfn_connector.rb', line 332

def connector_description()
  jsii_get_property("connectorDescription")
end

#connector_description=(value) ⇒ Object 



336
337
338
339
 
# File 'kafka_connect/cfn_connector.rb', line 336

def connector_description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorDescription") unless value.nil?
  jsii_set_property("connectorDescription", value)
end

#connector_name ⇒ String

The name of the connector.

Returns:

  • (String) 


245
246
247
 
# File 'kafka_connect/cfn_connector.rb', line 245

def connector_name()
  jsii_get_property("connectorName")
end

#connector_name=(value) ⇒ Object 



249
250
251
252
 
# File 'kafka_connect/cfn_connector.rb', line 249

def connector_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "connectorName")
  jsii_set_property("connectorName", value)
end

#connector_ref ⇒ AWSCDK::Interfaces::AWSKafkaconnect::ConnectorReference

A reference to a Connector resource.

Returns:



213
214
215
 
# File 'kafka_connect/cfn_connector.rb', line 213

def connector_ref()
  jsii_get_property("connectorRef")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


107
108
109
 
# File 'kafka_connect/cfn_connector.rb', line 107

def creation_stack()
  jsii_get_property("creationStack")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



167
168
169
 
# File 'kafka_connect/cfn_connector.rb', line 167

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



597
598
599
600
601
 
# File 'kafka_connect/cfn_connector.rb', line 597

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



608
609
610
611
 
# File 'kafka_connect/cfn_connector.rb', line 608

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



678
679
680
681
 
# File 'kafka_connect/cfn_connector.rb', line 678

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#kafka_cluster ⇒ AWSCDK::IResolvable, AWSCDK::KafkaConnect::CfnConnector::KafkaClusterProperty

The details of the Apache Kafka cluster to which the connector is connected.

Returns:



257
258
259
 
# File 'kafka_connect/cfn_connector.rb', line 257

def kafka_cluster()
  jsii_get_property("kafkaCluster")
end

#kafka_cluster=(value) ⇒ Object 



261
262
263
264
265
 
# File 'kafka_connect/cfn_connector.rb', line 261

def kafka_cluster=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KafkaConnect::CfnConnector::KafkaClusterProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rYWZrYWNvbm5lY3QuQ2ZuQ29ubmVjdG9yLkthZmthQ2x1c3RlclByb3BlcnR5In1dfX0=")), "kafkaCluster")
  jsii_set_property("kafkaCluster", value)
end

#kafka_cluster_client_authentication ⇒ AWSCDK::IResolvable, AWSCDK::KafkaConnect::CfnConnector::KafkaClusterClientAuthenticationProperty

The type of client authentication used to connect to the Apache Kafka cluster.

Returns:



270
271
272
 
# File 'kafka_connect/cfn_connector.rb', line 270

def kafka_cluster_client_authentication()
  jsii_get_property("kafkaClusterClientAuthentication")
end

#kafka_cluster_client_authentication=(value) ⇒ Object 



274
275
276
277
278
 
# File 'kafka_connect/cfn_connector.rb', line 274

def kafka_cluster_client_authentication=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KafkaConnect::CfnConnector::KafkaClusterClientAuthenticationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rYWZrYWNvbm5lY3QuQ2ZuQ29ubmVjdG9yLkthZmthQ2x1c3RlckNsaWVudEF1dGhlbnRpY2F0aW9uUHJvcGVydHkifV19fQ==")), "kafkaClusterClientAuthentication")
  jsii_set_property("kafkaClusterClientAuthentication", value)
end

#kafka_cluster_encryption_in_transit ⇒ AWSCDK::IResolvable, AWSCDK::KafkaConnect::CfnConnector::KafkaClusterEncryptionInTransitProperty

Details of encryption in transit to the Apache Kafka cluster.

Returns:



283
284
285
 
# File 'kafka_connect/cfn_connector.rb', line 283

def kafka_cluster_encryption_in_transit()
  jsii_get_property("kafkaClusterEncryptionInTransit")
end

#kafka_cluster_encryption_in_transit=(value) ⇒ Object 



287
288
289
290
291
 
# File 'kafka_connect/cfn_connector.rb', line 287

def kafka_cluster_encryption_in_transit=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KafkaConnect::CfnConnector::KafkaClusterEncryptionInTransitProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rYWZrYWNvbm5lY3QuQ2ZuQ29ubmVjdG9yLkthZmthQ2x1c3RlckVuY3J5cHRpb25JblRyYW5zaXRQcm9wZXJ0eSJ9XX19")), "kafkaClusterEncryptionInTransit")
  jsii_set_property("kafkaClusterEncryptionInTransit", value)
end

#kafka_connect_version ⇒ String

The version of Kafka Connect.

Returns:

  • (String) 


296
297
298
 
# File 'kafka_connect/cfn_connector.rb', line 296

def kafka_connect_version()
  jsii_get_property("kafkaConnectVersion")
end

#kafka_connect_version=(value) ⇒ Object 



300
301
302
303
 
# File 'kafka_connect/cfn_connector.rb', line 300

def kafka_connect_version=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "kafkaConnectVersion")
  jsii_set_property("kafkaConnectVersion", value)
end

#log_delivery ⇒ AWSCDK::IResolvable, ...

The settings for delivering connector logs to Amazon CloudWatch Logs.

Returns:



344
345
346
 
# File 'kafka_connect/cfn_connector.rb', line 344

def log_delivery()
  jsii_get_property("logDelivery")
end

#log_delivery=(value) ⇒ Object 



348
349
350
351
352
 
# File 'kafka_connect/cfn_connector.rb', line 348

def log_delivery=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KafkaConnect::CfnConnector::LogDeliveryProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rYWZrYWNvbm5lY3QuQ2ZuQ29ubmVjdG9yLkxvZ0RlbGl2ZXJ5UHJvcGVydHkifV19fQ==")), "logDelivery") unless value.nil?
  jsii_set_property("logDelivery", value)
end

#logical_id ⇒ String

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String) 


119
120
121
 
# File 'kafka_connect/cfn_connector.rb', line 119

def logical_id()
  jsii_get_property("logicalId")
end

#network_type ⇒ String?

The network type of the connector.

Returns:

  • (String, nil) 


357
358
359
 
# File 'kafka_connect/cfn_connector.rb', line 357

def network_type()
  jsii_get_property("networkType")
end

#network_type=(value) ⇒ Object 



361
362
363
364
 
# File 'kafka_connect/cfn_connector.rb', line 361

def network_type=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "networkType") unless value.nil?
  jsii_set_property("networkType", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


102
103
104
 
# File 'kafka_connect/cfn_connector.rb', line 102

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



619
620
621
 
# File 'kafka_connect/cfn_connector.rb', line 619

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



626
627
628
 
# File 'kafka_connect/cfn_connector.rb', line 626

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



419
420
421
422
 
# File 'kafka_connect/cfn_connector.rb', line 419

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#plugins ⇒ AWSCDK::IResolvable, Array<AWSCDK::IResolvable, AWSCDK::KafkaConnect::CfnConnector::PluginProperty>

Specifies which plugin to use for the connector.

Returns:



308
309
310
 
# File 'kafka_connect/cfn_connector.rb', line 308

def plugins()
  jsii_get_property("plugins")
end

#plugins=(value) ⇒ Object 



312
313
314
315
 
# File 'kafka_connect/cfn_connector.rb', line 312

def plugins=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3Nfa2Fma2Fjb25uZWN0LkNmbkNvbm5lY3Rvci5QbHVnaW5Qcm9wZXJ0eSJ9XX19LCJraW5kIjoiYXJyYXkifX1dfX0=")), "plugins")
  jsii_set_property("plugins", value)
end

#ref ⇒ String

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String) 


138
139
140
 
# File 'kafka_connect/cfn_connector.rb', line 138

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



637
638
639
640
 
# File 'kafka_connect/cfn_connector.rb', line 637

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


644
645
646
647
 
# File 'kafka_connect/cfn_connector.rb', line 644

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



654
655
656
657
658
 
# File 'kafka_connect/cfn_connector.rb', line 654

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#service_execution_role_arn ⇒ String

The Amazon Resource Name (ARN) of the IAM role used by the connector to access Amazon Web Services resources.

Returns:

  • (String) 


320
321
322
 
# File 'kafka_connect/cfn_connector.rb', line 320

def service_execution_role_arn()
  jsii_get_property("serviceExecutionRoleArn")
end

#service_execution_role_arn=(value) ⇒ Object 



324
325
326
327
 
# File 'kafka_connect/cfn_connector.rb', line 324

def service_execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceExecutionRoleArn")
  jsii_set_property("serviceExecutionRoleArn", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



663
664
665
 
# File 'kafka_connect/cfn_connector.rb', line 663

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



128
129
130
 
# File 'kafka_connect/cfn_connector.rb', line 128

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

A collection of tags associated with a resource.

Returns:



369
370
371
 
# File 'kafka_connect/cfn_connector.rb', line 369

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



373
374
375
376
377
 
# File 'kafka_connect/cfn_connector.rb', line 373

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



395
396
397
 
# File 'kafka_connect/cfn_connector.rb', line 395

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


175
176
177
 
# File 'kafka_connect/cfn_connector.rb', line 175

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


185
186
187
 
# File 'kafka_connect/cfn_connector.rb', line 185

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


669
670
671
672
 
# File 'kafka_connect/cfn_connector.rb', line 669

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


408
409
410
411
412
413
 
# File 'kafka_connect/cfn_connector.rb', line 408

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end

#worker_configuration ⇒ AWSCDK::IResolvable, ...

The worker configurations that are in use with the connector.

Returns:



382
383
384
 
# File 'kafka_connect/cfn_connector.rb', line 382

def worker_configuration()
  jsii_get_property("workerConfiguration")
end

#worker_configuration=(value) ⇒ Object 



386
387
388
389
390
 
# File 'kafka_connect/cfn_connector.rb', line 386

def worker_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::KafkaConnect::CfnConnector::WorkerConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19rYWZrYWNvbm5lY3QuQ2ZuQ29ubmVjdG9yLldvcmtlckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "workerConfiguration") unless value.nil?
  jsii_set_property("workerConfiguration", value)
end