DatasourceEntityDetailsEntityConfig

pydantic model openapi_client.models.datasource_entity_details_entity_config.DatasourceEntityDetailsEntityConfig

Type-specific configuration. JDBC Bulk Load uses DMS instance fields. JDBC Advanced Load uses Kafka cluster fields. Streams uses LambdaHandler and MemorySize.

Fields:
field instance_multi_az: Optional[StrictBool] = None (alias 'InstanceMultiAZ')

Multi-AZ for JDBC Bulk Load DMS instances. Defaults to false.

field auto_minor_version_upgrade: Optional[StrictBool] = None (alias 'AutoMinorVersionUpgrade')

Auto minor version upgrade for JDBC Bulk Load. Defaults to false.

field preferred_maintenance_window: Optional[StrictStr] = None (alias 'PreferredMaintenanceWindow')

Maintenance window for JDBC Bulk Load. Format ddd:hh24:mi-ddd:hh24:mi.

field apply_immediately: Optional[StrictStr] = None (alias 'ApplyImmediately')

Apply changes immediately on JDBC Bulk Load update.

field dataflow_id: Optional[StrictStr] = None (alias 'DataflowId')

Required when updating a dedicated JDBC Bulk Load instance that is not stored as a shared entity UUID.

field shared_instance: Optional[StrictStr] = None (alias 'SharedInstance')

yes for shared JDBC Bulk Load instances. no for dedicated.

field instance_class: Optional[StrictStr] = None (alias 'InstanceClass')

DMS instance class for JDBC Bulk Load. Required on shared instance create.

field allocated_storage: Optional[DatasourceEntityDetailsEntityConfigAllocatedStorage] = None (alias 'AllocatedStorage')
field instance_az: Optional[StrictStr] = None (alias 'InstanceAZ')

Availability zone for JDBC Bulk Load. Required on shared instance create. Cannot be changed on update.

field dms_version: Optional[StrictStr] = None (alias 'DmsVersion')

DMS engine version for JDBC Bulk Load. Upgrades only on update.

field publicly_accessible_instance: Optional[StrictBool] = None (alias 'PubliclyAccessibleInstance')

Internet access for JDBC Bulk Load instances. Defaults to false.

field lambda_handler: Optional[StrictStr] = None (alias 'LambdaHandler')

Lambda handler for Streams transformation functions. Required on Streams create and update.

field memory_size: Optional[StrictInt] = None (alias 'MemorySize')

Lambda memory in MB for Streams. Allowed values are 128 to 1024 in 64 MB steps. Defaults to 128.

field cluster_size: Optional[StrictStr] = None (alias 'ClusterSize')

MSK broker instance type for JDBC Advanced Load. Defaults to kafka.t3.small.

field cluster_storage: Optional[StrictStr] = None (alias 'ClusterStorage')

Per-broker storage in GB for JDBC Advanced Load. Defaults to 20.

field number_of_brokers: Optional[StrictStr] = None (alias 'NumberOfBrokers')

Broker count for JDBC Advanced Load. Defaults to 2.

field list_of_consumers: Optional[List[StrictStr]] = None (alias 'ListOfConsumers')

Dataflow IDs that use this Streams transformation entity.

field kafka_version: Optional[StrictStr] = None (alias 'KafkaVersion')

Kafka version for JDBC Advanced Load. Only 3.7.x is supported. Defaults to 3.7.x. Cannot be changed on update.

field shared_cluster: Optional[StrictStr] = None (alias 'SharedCluster')

yes for shared JDBC Advanced Load clusters. no for dedicated.

field cluster_arn: Optional[StrictStr] = None (alias 'ClusterArn')

MSK cluster ARN after the cluster exists.

field cluster_log_group_name: Optional[StrictStr] = None (alias 'ClusterLogGroupName')

CloudWatch log group for JDBC Advanced Load broker logs.

field custom_config_arn: Optional[StrictStr] = None (alias 'CustomConfigArn')

Optional custom MSK configuration ARN for JDBC Advanced Load.

field is_auto_scaling_enabled: Optional[StrictBool] = None (alias 'IsAutoScalingEnabled')

Storage autoscaling for JDBC Advanced Load. Defaults to true on create.

field is_auto_terminate_enabled: Optional[StrictBool] = None (alias 'IsAutoTerminateEnabled')

Auto-termination flag nested under EntityConfig when present.

field data_retention_in_hours: Optional[StrictStr] = None (alias 'DataRetentionInHours')

Topic retention hours for JDBC Advanced Load. Defaults to 168. Cannot be changed on update.

field free_until: Optional[StrictStr] = None (alias 'FreeUntil')

Free-until timestamp for JDBC Bulk Load DMS instances when set.

field auto_scaling_config: Optional[DatasourceEntityDetailsEntityConfigAutoScalingConfig] = None (alias 'AutoScalingConfig')
field schedule_config: Optional[DatasourceEntityDetailsEntityConfigScheduleConfig] = None (alias 'ScheduleConfig')
to_str()

Returns the string representation of the model using alias

Return type:

str

to_json()

Returns the JSON representation of the model using alias

Return type:

str

classmethod from_json(json_str)

Create an instance of DatasourceEntityDetailsEntityConfig from a JSON string

Return type:

Optional[Self]

to_dict()

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic’s self.model_dump(by_alias=True):

  • None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

Return type:

Dict[str, Any]

classmethod from_dict(obj)

Create an instance of DatasourceEntityDetailsEntityConfig from a dict

Return type:

Optional[Self]