PostgresqlConnectionSummary

class oci.golden_gate.models.PostgresqlConnectionSummary(**kwargs)

Bases: oci.golden_gate.models.connection_summary.ConnectionSummary

Summary of the PostgreSQL Database Connection.

Attributes

CONNECTION_TYPE_AMAZON_KINESIS str(object=’’) -> str
CONNECTION_TYPE_AMAZON_REDSHIFT str(object=’’) -> str
CONNECTION_TYPE_AMAZON_S3 str(object=’’) -> str
CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE str(object=’’) -> str
CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS str(object=’’) -> str
CONNECTION_TYPE_DB2 str(object=’’) -> str
CONNECTION_TYPE_ELASTICSEARCH str(object=’’) -> str
CONNECTION_TYPE_GENERIC str(object=’’) -> str
CONNECTION_TYPE_GOLDENGATE str(object=’’) -> str
CONNECTION_TYPE_GOOGLE_BIGQUERY str(object=’’) -> str
CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE str(object=’’) -> str
CONNECTION_TYPE_HDFS str(object=’’) -> str
CONNECTION_TYPE_JAVA_MESSAGE_SERVICE str(object=’’) -> str
CONNECTION_TYPE_KAFKA str(object=’’) -> str
CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY str(object=’’) -> str
CONNECTION_TYPE_MICROSOFT_SQLSERVER str(object=’’) -> str
CONNECTION_TYPE_MONGODB str(object=’’) -> str
CONNECTION_TYPE_MYSQL str(object=’’) -> str
CONNECTION_TYPE_OCI_OBJECT_STORAGE str(object=’’) -> str
CONNECTION_TYPE_ORACLE str(object=’’) -> str
CONNECTION_TYPE_ORACLE_NOSQL str(object=’’) -> str
CONNECTION_TYPE_POSTGRESQL str(object=’’) -> str
CONNECTION_TYPE_REDIS str(object=’’) -> str
CONNECTION_TYPE_SNOWFLAKE str(object=’’) -> str
ROUTING_METHOD_DEDICATED_ENDPOINT str(object=’’) -> str
ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT str(object=’’) -> str
ROUTING_METHOD_SHARED_SERVICE_ENDPOINT str(object=’’) -> str
additional_attributes Gets the additional_attributes of this PostgresqlConnectionSummary.
compartment_id [Required] Gets the compartment_id of this ConnectionSummary.
connection_type [Required] Gets the connection_type of this ConnectionSummary.
database_name [Required] Gets the database_name of this PostgresqlConnectionSummary.
db_system_id Gets the db_system_id of this PostgresqlConnectionSummary.
defined_tags Gets the defined_tags of this ConnectionSummary.
description Gets the description of this ConnectionSummary.
display_name [Required] Gets the display_name of this ConnectionSummary.
freeform_tags Gets the freeform_tags of this ConnectionSummary.
host [Required] Gets the host of this PostgresqlConnectionSummary.
id [Required] Gets the id of this ConnectionSummary.
ingress_ips Gets the ingress_ips of this ConnectionSummary.
key_id Gets the key_id of this ConnectionSummary.
lifecycle_details Gets the lifecycle_details of this ConnectionSummary.
lifecycle_state [Required] Gets the lifecycle_state of this ConnectionSummary.
locks Gets the locks of this ConnectionSummary.
nsg_ids Gets the nsg_ids of this ConnectionSummary.
port [Required] Gets the port of this PostgresqlConnectionSummary.
private_ip Gets the private_ip of this PostgresqlConnectionSummary.
routing_method Gets the routing_method of this ConnectionSummary.
security_protocol [Required] Gets the security_protocol of this PostgresqlConnectionSummary.
ssl_mode Gets the ssl_mode of this PostgresqlConnectionSummary.
subnet_id Gets the subnet_id of this ConnectionSummary.
system_tags Gets the system_tags of this ConnectionSummary.
technology_type [Required] Gets the technology_type of this PostgresqlConnectionSummary.
time_created [Required] Gets the time_created of this ConnectionSummary.
time_updated [Required] Gets the time_updated of this ConnectionSummary.
username [Required] Gets the username of this PostgresqlConnectionSummary.
vault_id Gets the vault_id of this ConnectionSummary.

Methods

__init__(**kwargs) Initializes a new PostgresqlConnectionSummary object with values from keyword arguments.
get_subtype(object_dictionary) Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.
CONNECTION_TYPE_AMAZON_KINESIS = 'AMAZON_KINESIS'
CONNECTION_TYPE_AMAZON_REDSHIFT = 'AMAZON_REDSHIFT'
CONNECTION_TYPE_AMAZON_S3 = 'AMAZON_S3'
CONNECTION_TYPE_AZURE_DATA_LAKE_STORAGE = 'AZURE_DATA_LAKE_STORAGE'
CONNECTION_TYPE_AZURE_SYNAPSE_ANALYTICS = 'AZURE_SYNAPSE_ANALYTICS'
CONNECTION_TYPE_DB2 = 'DB2'
CONNECTION_TYPE_ELASTICSEARCH = 'ELASTICSEARCH'
CONNECTION_TYPE_GENERIC = 'GENERIC'
CONNECTION_TYPE_GOLDENGATE = 'GOLDENGATE'
CONNECTION_TYPE_GOOGLE_BIGQUERY = 'GOOGLE_BIGQUERY'
CONNECTION_TYPE_GOOGLE_CLOUD_STORAGE = 'GOOGLE_CLOUD_STORAGE'
CONNECTION_TYPE_HDFS = 'HDFS'
CONNECTION_TYPE_JAVA_MESSAGE_SERVICE = 'JAVA_MESSAGE_SERVICE'
CONNECTION_TYPE_KAFKA = 'KAFKA'
CONNECTION_TYPE_KAFKA_SCHEMA_REGISTRY = 'KAFKA_SCHEMA_REGISTRY'
CONNECTION_TYPE_MICROSOFT_SQLSERVER = 'MICROSOFT_SQLSERVER'
CONNECTION_TYPE_MONGODB = 'MONGODB'
CONNECTION_TYPE_MYSQL = 'MYSQL'
CONNECTION_TYPE_OCI_OBJECT_STORAGE = 'OCI_OBJECT_STORAGE'
CONNECTION_TYPE_ORACLE = 'ORACLE'
CONNECTION_TYPE_ORACLE_NOSQL = 'ORACLE_NOSQL'
CONNECTION_TYPE_POSTGRESQL = 'POSTGRESQL'
CONNECTION_TYPE_REDIS = 'REDIS'
CONNECTION_TYPE_SNOWFLAKE = 'SNOWFLAKE'
ROUTING_METHOD_DEDICATED_ENDPOINT = 'DEDICATED_ENDPOINT'
ROUTING_METHOD_SHARED_DEPLOYMENT_ENDPOINT = 'SHARED_DEPLOYMENT_ENDPOINT'
ROUTING_METHOD_SHARED_SERVICE_ENDPOINT = 'SHARED_SERVICE_ENDPOINT'
__init__(**kwargs)

Initializes a new PostgresqlConnectionSummary object with values from keyword arguments. The default value of the connection_type attribute of this class is POSTGRESQL and it should not be changed. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters:
  • connection_type (str) – The value to assign to the connection_type property of this PostgresqlConnectionSummary. Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”
  • id (str) – The value to assign to the id property of this PostgresqlConnectionSummary.
  • display_name (str) – The value to assign to the display_name property of this PostgresqlConnectionSummary.
  • description (str) – The value to assign to the description property of this PostgresqlConnectionSummary.
  • compartment_id (str) – The value to assign to the compartment_id property of this PostgresqlConnectionSummary.
  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this PostgresqlConnectionSummary.
  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this PostgresqlConnectionSummary.
  • system_tags (dict(str, dict(str, object))) – The value to assign to the system_tags property of this PostgresqlConnectionSummary.
  • lifecycle_state (str) – The value to assign to the lifecycle_state property of this PostgresqlConnectionSummary.
  • lifecycle_details (str) – The value to assign to the lifecycle_details property of this PostgresqlConnectionSummary.
  • time_created (datetime) – The value to assign to the time_created property of this PostgresqlConnectionSummary.
  • time_updated (datetime) – The value to assign to the time_updated property of this PostgresqlConnectionSummary.
  • vault_id (str) – The value to assign to the vault_id property of this PostgresqlConnectionSummary.
  • key_id (str) – The value to assign to the key_id property of this PostgresqlConnectionSummary.
  • ingress_ips (list[oci.golden_gate.models.IngressIpDetails]) – The value to assign to the ingress_ips property of this PostgresqlConnectionSummary.
  • nsg_ids (list[str]) – The value to assign to the nsg_ids property of this PostgresqlConnectionSummary.
  • subnet_id (str) – The value to assign to the subnet_id property of this PostgresqlConnectionSummary.
  • routing_method (str) – The value to assign to the routing_method property of this PostgresqlConnectionSummary. Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”
  • locks (list[oci.golden_gate.models.ResourceLock]) – The value to assign to the locks property of this PostgresqlConnectionSummary.
  • technology_type (str) – The value to assign to the technology_type property of this PostgresqlConnectionSummary.
  • database_name (str) – The value to assign to the database_name property of this PostgresqlConnectionSummary.
  • host (str) – The value to assign to the host property of this PostgresqlConnectionSummary.
  • port (int) – The value to assign to the port property of this PostgresqlConnectionSummary.
  • username (str) – The value to assign to the username property of this PostgresqlConnectionSummary.
  • additional_attributes (list[oci.golden_gate.models.NameValuePair]) – The value to assign to the additional_attributes property of this PostgresqlConnectionSummary.
  • security_protocol (str) – The value to assign to the security_protocol property of this PostgresqlConnectionSummary.
  • ssl_mode (str) – The value to assign to the ssl_mode property of this PostgresqlConnectionSummary.
  • private_ip (str) – The value to assign to the private_ip property of this PostgresqlConnectionSummary.
  • db_system_id (str) – The value to assign to the db_system_id property of this PostgresqlConnectionSummary.
additional_attributes

Gets the additional_attributes of this PostgresqlConnectionSummary. An array of name-value pair attribute entries. Used as additional parameters in connection string.

Returns:The additional_attributes of this PostgresqlConnectionSummary.
Return type:list[oci.golden_gate.models.NameValuePair]
compartment_id

[Required] Gets the compartment_id of this ConnectionSummary. The OCID of the compartment being referenced.

Returns:The compartment_id of this ConnectionSummary.
Return type:str
connection_type

[Required] Gets the connection_type of this ConnectionSummary. The connection type.

Allowed values for this property are: “GOLDENGATE”, “KAFKA”, “KAFKA_SCHEMA_REGISTRY”, “MYSQL”, “JAVA_MESSAGE_SERVICE”, “MICROSOFT_SQLSERVER”, “OCI_OBJECT_STORAGE”, “ORACLE”, “AZURE_DATA_LAKE_STORAGE”, “POSTGRESQL”, “AZURE_SYNAPSE_ANALYTICS”, “SNOWFLAKE”, “AMAZON_S3”, “HDFS”, “ORACLE_NOSQL”, “MONGODB”, “AMAZON_KINESIS”, “AMAZON_REDSHIFT”, “DB2”, “REDIS”, “ELASTICSEARCH”, “GENERIC”, “GOOGLE_CLOUD_STORAGE”, “GOOGLE_BIGQUERY”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The connection_type of this ConnectionSummary.
Return type:str
database_name

[Required] Gets the database_name of this PostgresqlConnectionSummary. The name of the database.

Returns:The database_name of this PostgresqlConnectionSummary.
Return type:str
db_system_id

Gets the db_system_id of this PostgresqlConnectionSummary. The OCID of the database system being referenced.

Returns:The db_system_id of this PostgresqlConnectionSummary.
Return type:str
defined_tags

Gets the defined_tags of this ConnectionSummary. Tags defined for this resource. Each key is predefined and scoped to a namespace.

Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns:The defined_tags of this ConnectionSummary.
Return type:dict(str, dict(str, object))
description

Gets the description of this ConnectionSummary. Metadata about this specific object.

Returns:The description of this ConnectionSummary.
Return type:str
display_name

[Required] Gets the display_name of this ConnectionSummary. An object’s Display Name.

Returns:The display_name of this ConnectionSummary.
Return type:str
freeform_tags

Gets the freeform_tags of this ConnectionSummary. A simple key-value pair that is applied without any predefined name, type, or scope. Exists for cross-compatibility only.

Example: {“bar-key”: “value”}

Returns:The freeform_tags of this ConnectionSummary.
Return type:dict(str, str)
static get_subtype(object_dictionary)

Given the hash representation of a subtype of this class, use the info in the hash to return the class of the subtype.

host

[Required] Gets the host of this PostgresqlConnectionSummary. The name or address of a host.

Returns:The host of this PostgresqlConnectionSummary.
Return type:str
id

[Required] Gets the id of this ConnectionSummary. The OCID of the connection being referenced.

Returns:The id of this ConnectionSummary.
Return type:str
ingress_ips

Gets the ingress_ips of this ConnectionSummary. List of ingress IP addresses from where the GoldenGate deployment connects to this connection’s privateIp. Customers may optionally set up ingress security rules to restrict traffic from these IP addresses.

Returns:The ingress_ips of this ConnectionSummary.
Return type:list[oci.golden_gate.models.IngressIpDetails]
key_id

Gets the key_id of this ConnectionSummary. Refers to the customer’s master key OCID. If provided, it references a key to manage secrets. Customers must add policies to permit GoldenGate to use this key.

Returns:The key_id of this ConnectionSummary.
Return type:str
lifecycle_details

Gets the lifecycle_details of this ConnectionSummary. Describes the object’s current state in detail. For example, it can be used to provide actionable information for a resource in a Failed state.

Returns:The lifecycle_details of this ConnectionSummary.
Return type:str
lifecycle_state

[Required] Gets the lifecycle_state of this ConnectionSummary. Possible lifecycle states for connection.

Returns:The lifecycle_state of this ConnectionSummary.
Return type:str
locks

Gets the locks of this ConnectionSummary. Locks associated with this resource.

Returns:The locks of this ConnectionSummary.
Return type:list[oci.golden_gate.models.ResourceLock]
nsg_ids

Gets the nsg_ids of this ConnectionSummary. An array of Network Security Group OCIDs used to define network access for either Deployments or Connections.

Returns:The nsg_ids of this ConnectionSummary.
Return type:list[str]
port

[Required] Gets the port of this PostgresqlConnectionSummary. The port of an endpoint usually specified for a connection.

Returns:The port of this PostgresqlConnectionSummary.
Return type:int
private_ip

Gets the private_ip of this PostgresqlConnectionSummary. Deprecated: this field will be removed in future versions. Either specify the private IP in the connectionString or host field, or make sure the host name is resolvable in the target VCN.

The private IP address of the connection’s endpoint in the customer’s VCN, typically a database endpoint or a big data endpoint (e.g. Kafka bootstrap server). In case the privateIp is provided, the subnetId must also be provided. In case the privateIp (and the subnetId) is not provided it is assumed the datasource is publicly accessible. In case the connection is accessible only privately, the lack of privateIp will result in not being able to access the connection.

Returns:The private_ip of this PostgresqlConnectionSummary.
Return type:str
routing_method

Gets the routing_method of this ConnectionSummary. Controls the network traffic direction to the target: SHARED_SERVICE_ENDPOINT: Traffic flows through the Goldengate Service’s network to public hosts. Cannot be used for private targets. SHARED_DEPLOYMENT_ENDPOINT: Network traffic flows from the assigned deployment’s private endpoint through the deployment’s subnet. DEDICATED_ENDPOINT: A dedicated private endpoint is created in the target VCN subnet for the connection. The subnetId is required when DEDICATED_ENDPOINT networking is selected.

Allowed values for this property are: “SHARED_SERVICE_ENDPOINT”, “SHARED_DEPLOYMENT_ENDPOINT”, “DEDICATED_ENDPOINT”, ‘UNKNOWN_ENUM_VALUE’. Any unrecognized values returned by a service will be mapped to ‘UNKNOWN_ENUM_VALUE’.

Returns:The routing_method of this ConnectionSummary.
Return type:str
security_protocol

[Required] Gets the security_protocol of this PostgresqlConnectionSummary. Security protocol for PostgreSQL.

Returns:The security_protocol of this PostgresqlConnectionSummary.
Return type:str
ssl_mode

Gets the ssl_mode of this PostgresqlConnectionSummary. SSL modes for PostgreSQL.

Returns:The ssl_mode of this PostgresqlConnectionSummary.
Return type:str
subnet_id

Gets the subnet_id of this ConnectionSummary. The OCID of the target subnet of the dedicated connection.

Returns:The subnet_id of this ConnectionSummary.
Return type:str
system_tags

Gets the system_tags of this ConnectionSummary. The system tags associated with this resource, if any. The system tags are set by Oracle Cloud Infrastructure services. Each key is predefined and scoped to namespaces. For more information, see Resource Tags.

Example: {orcl-cloud: {free-tier-retain: true}}

Returns:The system_tags of this ConnectionSummary.
Return type:dict(str, dict(str, object))
technology_type

[Required] Gets the technology_type of this PostgresqlConnectionSummary. The PostgreSQL technology type.

Returns:The technology_type of this PostgresqlConnectionSummary.
Return type:str
time_created

[Required] Gets the time_created of this ConnectionSummary. The time the resource was created. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:The time_created of this ConnectionSummary.
Return type:datetime
time_updated

[Required] Gets the time_updated of this ConnectionSummary. The time the resource was last updated. The format is defined by RFC3339, such as 2016-08-25T21:10:29.600Z.

Returns:The time_updated of this ConnectionSummary.
Return type:datetime
username

[Required] Gets the username of this PostgresqlConnectionSummary. The username Oracle GoldenGate uses to connect the associated system of the given technology. This username must already exist and be available by the system/application to be connected to and must conform to the case sensitivty requirments defined in it.

Returns:The username of this PostgresqlConnectionSummary.
Return type:str
vault_id

Gets the vault_id of this ConnectionSummary. Refers to the customer’s vault OCID. If provided, it references a vault where GoldenGate can manage secrets. Customers must add policies to permit GoldenGate to manage secrets contained within this vault.

Returns:The vault_id of this ConnectionSummary.
Return type:str