oci.DataFlow.SqlEndpoint

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

State string

The current state of the Sql Endpoint.

StateMessage string

A message describing the reason why the resource is in it's current state. Helps bubble up errors in state changes. For example, it can be used to provide actionable information for a resource in the Failed state.

SystemTags Dictionary<string, string>

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}}

TimeCreated string

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Id string

The provider-assigned unique ID for this managed resource.

JdbcEndpointUrl string

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

LakeId string

Oracle Cloud Infrastructure lake OCID

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

State string

The current state of the Sql Endpoint.

StateMessage string

SystemTags map[string]string

TimeCreated string

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

id String

The provider-assigned unique ID for this managed resource.

jdbcEndpointUrl String

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lakeId String

Oracle Cloud Infrastructure lake OCID

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

state String

The current state of the Sql Endpoint.

stateMessage String

systemTags Map<String,String>

timeCreated String

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

id string

The provider-assigned unique ID for this managed resource.

jdbcEndpointUrl string

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lakeId string

Oracle Cloud Infrastructure lake OCID

lastAcceptedRequestToken string

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

state string

The current state of the Sql Endpoint.

stateMessage string

systemTags {[key: string]: string}

timeCreated string

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

timeUpdated string

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

warehouseBucketUri string

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

id str

The provider-assigned unique ID for this managed resource.

jdbc_endpoint_url str

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lake_id str

Oracle Cloud Infrastructure lake OCID

last_accepted_request_token str

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

state str

The current state of the Sql Endpoint.

state_message str

system_tags Mapping[str, str]

time_created str

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

time_updated str

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

warehouse_bucket_uri str

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

id String

The provider-assigned unique ID for this managed resource.

jdbcEndpointUrl String

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lakeId String

Oracle Cloud Infrastructure lake OCID

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

state String

The current state of the Sql Endpoint.

stateMessage String

systemTags Map<String>

timeCreated String

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

DriverShapeConfig SqlEndpointDriverShapeConfig

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

Look up Existing SqlEndpoint Resource

Get an existing SqlEndpoint resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: SqlEndpointState, opts?: CustomResourceOptions): SqlEndpoint

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        compartment_id: Optional[str] = None,
        defined_tags: Optional[Mapping[str, str]] = None,
        description: Optional[str] = None,
        display_name: Optional[str] = None,
        driver_shape: Optional[str] = None,
        driver_shape_config: Optional[_dataflow.SqlEndpointDriverShapeConfigArgs] = None,
        executor_shape: Optional[str] = None,
        executor_shape_config: Optional[_dataflow.SqlEndpointExecutorShapeConfigArgs] = None,
        freeform_tags: Optional[Mapping[str, str]] = None,
        jdbc_endpoint_url: Optional[str] = None,
        lake_id: Optional[str] = None,
        last_accepted_request_token: Optional[str] = None,
        max_executor_count: Optional[int] = None,
        metastore_id: Optional[str] = None,
        min_executor_count: Optional[int] = None,
        network_configuration: Optional[_dataflow.SqlEndpointNetworkConfigurationArgs] = None,
        spark_advanced_configurations: Optional[Mapping[str, str]] = None,
        sql_endpoint_version: Optional[str] = None,
        state: Optional[str] = None,
        state_message: Optional[str] = None,
        system_tags: Optional[Mapping[str, str]] = None,
        time_created: Optional[str] = None,
        time_updated: Optional[str] = None,
        warehouse_bucket_uri: Optional[str] = None) -> SqlEndpoint

func GetSqlEndpoint(ctx *Context, name string, id IDInput, state *SqlEndpointState, opts ...ResourceOption) (*SqlEndpoint, error)

public static SqlEndpoint Get(string name, Input<string> id, SqlEndpointState? state, CustomResourceOptions? opts = null)

public static SqlEndpoint get(String name, Output<String> id, SqlEndpointState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

CompartmentId string

(Updatable) The identifier of the compartment used with the SQL Endpoint.

DefinedTags Dictionary<string, string>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

Description string

The description of CreateSQLEndpointDetails.

DisplayName string

The SQL Endpoint name, which can be changed.

DriverShape string

The shape of the SQL Endpoint driver instance.

This is used to configure the shape of the driver or executor if a flexible shape is used.

ExecutorShape string

The shape of the SQL Endpoint worker instance.

ExecutorShapeConfig SqlEndpointExecutorShapeConfig

This is used to configure the shape of the driver or executor if a flexible shape is used.

FreeformTags Dictionary<string, string>

(Updatable) Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags. Example: {"Department": "Finance"}

JdbcEndpointUrl string

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

LakeId string

Oracle Cloud Infrastructure lake OCID

NetworkConfiguration SqlEndpointNetworkConfiguration

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

MaxExecutorCount int

The maximum number of executors.

MetastoreId string

Metastore OCID

MinExecutorCount int

The minimum number of executors.

The network configuration of a SQL Endpoint.

SparkAdvancedConfigurations Dictionary<string, string>

The Spark configuration passed to the running process. See https://spark.apache.org/docs/latest/configuration.html#available-properties. Example: { "spark.app.name" : "My App Name", "spark.shuffle.io.maxRetries" : "4" } Note: Not all Spark properties are permitted to be set. Attempting to set a property that is not allowed to be overwritten will cause a 400 status to be returned.

SqlEndpointVersion string

The version of the SQL Endpoint.

State string

The current state of the Sql Endpoint.

StateMessage string

SystemTags Dictionary<string, string>

TimeCreated string

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

DriverShapeConfig SqlEndpointDriverShapeConfigArgs

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

CompartmentId string

(Updatable) The identifier of the compartment used with the SQL Endpoint.

DefinedTags map[string]string

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

Description string

The description of CreateSQLEndpointDetails.

DisplayName string

The SQL Endpoint name, which can be changed.

DriverShape string

The shape of the SQL Endpoint driver instance.

This is used to configure the shape of the driver or executor if a flexible shape is used.

ExecutorShape string

The shape of the SQL Endpoint worker instance.

ExecutorShapeConfig SqlEndpointExecutorShapeConfigArgs

This is used to configure the shape of the driver or executor if a flexible shape is used.

FreeformTags map[string]string

JdbcEndpointUrl string

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

LakeId string

Oracle Cloud Infrastructure lake OCID

NetworkConfiguration SqlEndpointNetworkConfigurationArgs

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

MaxExecutorCount int

The maximum number of executors.

MetastoreId string

Metastore OCID

MinExecutorCount int

The minimum number of executors.

The network configuration of a SQL Endpoint.

SparkAdvancedConfigurations map[string]string

SqlEndpointVersion string

The version of the SQL Endpoint.

State string

The current state of the Sql Endpoint.

StateMessage string

SystemTags map[string]string

TimeCreated string

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

TimeUpdated string

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

driverShapeConfig SqlEndpointDriverShapeConfig

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId String

(Updatable) The identifier of the compartment used with the SQL Endpoint.

definedTags Map<String,String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description String

The description of CreateSQLEndpointDetails.

displayName String

The SQL Endpoint name, which can be changed.

driverShape String

The shape of the SQL Endpoint driver instance.

This is used to configure the shape of the driver or executor if a flexible shape is used.

executorShape String

The shape of the SQL Endpoint worker instance.

executorShapeConfig SqlEndpointExecutorShapeConfig

This is used to configure the shape of the driver or executor if a flexible shape is used.

freeformTags Map<String,String>

jdbcEndpointUrl String

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lakeId String

Oracle Cloud Infrastructure lake OCID

networkConfiguration SqlEndpointNetworkConfiguration

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

maxExecutorCount Integer

The maximum number of executors.

metastoreId String

Metastore OCID

minExecutorCount Integer

The minimum number of executors.

The network configuration of a SQL Endpoint.

sparkAdvancedConfigurations Map<String,String>

sqlEndpointVersion String

The version of the SQL Endpoint.

state String

The current state of the Sql Endpoint.

stateMessage String

systemTags Map<String,String>

timeCreated String

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

driverShapeConfig SqlEndpointDriverShapeConfig

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId string

(Updatable) The identifier of the compartment used with the SQL Endpoint.

definedTags {[key: string]: string}

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description string

The description of CreateSQLEndpointDetails.

displayName string

The SQL Endpoint name, which can be changed.

driverShape string

The shape of the SQL Endpoint driver instance.

This is used to configure the shape of the driver or executor if a flexible shape is used.

executorShape string

The shape of the SQL Endpoint worker instance.

executorShapeConfig SqlEndpointExecutorShapeConfig

This is used to configure the shape of the driver or executor if a flexible shape is used.

freeformTags {[key: string]: string}

jdbcEndpointUrl string

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lakeId string

Oracle Cloud Infrastructure lake OCID

lastAcceptedRequestToken string

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

maxExecutorCount number

The maximum number of executors.

metastoreId string

Metastore OCID

minExecutorCount number

The minimum number of executors.

networkConfiguration SqlEndpointNetworkConfiguration

The network configuration of a SQL Endpoint.

sparkAdvancedConfigurations {[key: string]: string}

sqlEndpointVersion string

The version of the SQL Endpoint.

state string

The current state of the Sql Endpoint.

stateMessage string

systemTags {[key: string]: string}

timeCreated string

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

timeUpdated string

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

warehouseBucketUri string

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartment_id str

(Updatable) The identifier of the compartment used with the SQL Endpoint.

defined_tags Mapping[str, str]

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description str

The description of CreateSQLEndpointDetails.

display_name str

The SQL Endpoint name, which can be changed.

driver_shape str

The shape of the SQL Endpoint driver instance.

driver_shape_config dataflow.SqlEndpointDriverShapeConfigArgs

This is used to configure the shape of the driver or executor if a flexible shape is used.

executor_shape str

The shape of the SQL Endpoint worker instance.

executor_shape_config dataflow.SqlEndpointExecutorShapeConfigArgs

This is used to configure the shape of the driver or executor if a flexible shape is used.

freeform_tags Mapping[str, str]

jdbc_endpoint_url str

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lake_id str

Oracle Cloud Infrastructure lake OCID

last_accepted_request_token str

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

max_executor_count int

The maximum number of executors.

metastore_id str

Metastore OCID

min_executor_count int

The minimum number of executors.

network_configuration dataflow.SqlEndpointNetworkConfigurationArgs

The network configuration of a SQL Endpoint.

spark_advanced_configurations Mapping[str, str]

sql_endpoint_version str

The version of the SQL Endpoint.

state str

The current state of the Sql Endpoint.

state_message str

system_tags Mapping[str, str]

time_created str

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

time_updated str

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.

warehouse_bucket_uri str

The warehouse bucket URI. It is a Oracle Cloud Infrastructure Object Storage bucket URI as defined here https://docs.oracle.com/en/cloud/paas/atp-cloud/atpud/object-storage-uris.html

** IMPORTANT ** Any change to a property that does not support update will force the destruction and recreation of the resource with the new property values

compartmentId String

(Updatable) The identifier of the compartment used with the SQL Endpoint.

definedTags Map<String>

(Updatable) Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: {"Operations.CostCenter": "42"}

description String

The description of CreateSQLEndpointDetails.

displayName String

The SQL Endpoint name, which can be changed.

driverShape String

The shape of the SQL Endpoint driver instance.

driverShapeConfig Property Map

This is used to configure the shape of the driver or executor if a flexible shape is used.

executorShape String

The shape of the SQL Endpoint worker instance.

executorShapeConfig Property Map

This is used to configure the shape of the driver or executor if a flexible shape is used.

freeformTags Map<String>

jdbcEndpointUrl String

The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI

lakeId String

Oracle Cloud Infrastructure lake OCID

networkConfiguration Property Map

This token is used by Splat, and indicates that the service accepts the request, and that the request is currently being processed.

maxExecutorCount Number

The maximum number of executors.

metastoreId String

Metastore OCID

minExecutorCount Number

The minimum number of executors.

The network configuration of a SQL Endpoint.

sparkAdvancedConfigurations Map<String>

sqlEndpointVersion String

The version of the SQL Endpoint.

state String

The current state of the Sql Endpoint.

stateMessage String

systemTags Map<String>

timeCreated String

The time the Sql Endpoint was created. An RFC3339 formatted datetime string.

timeUpdated String

The time the Sql Endpoint was updated. An RFC3339 formatted datetime string.