Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Oracle Cloud Infrastructure
  3. API Docs
  4. DataFlow
  5. getSqlEndpoints
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

oci.DataFlow.getSqlEndpoints

Explore with Pulumi AI

oci logo
Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
pulumi/pulumi-oci

    This data source provides the list of Sql Endpoints in Oracle Cloud Infrastructure Data Flow service.

    Lists all Sql Endpoints in the specified compartment. The query must include compartmentId or sqlEndpointId. If the query does not include either compartmentId or sqlEndpointId, an error is returned.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";

const testSqlEndpoints = oci.DataFlow.getSqlEndpoints({
    compartmentId: compartmentId,
    displayName: sqlEndpointDisplayName,
    sqlEndpointId: testSqlEndpoint.id,
    state: sqlEndpointState,
});

    import pulumi
import pulumi_oci as oci

test_sql_endpoints = oci.DataFlow.get_sql_endpoints(compartment_id=compartment_id,
    display_name=sql_endpoint_display_name,
    sql_endpoint_id=test_sql_endpoint["id"],
    state=sql_endpoint_state)

    package main

import (
	"github.com/pulumi/pulumi-oci/sdk/v2/go/oci/DataFlow"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := DataFlow.GetSqlEndpoints(ctx, &dataflow.GetSqlEndpointsArgs{
			CompartmentId: pulumi.StringRef(compartmentId),
			DisplayName:   pulumi.StringRef(sqlEndpointDisplayName),
			SqlEndpointId: pulumi.StringRef(testSqlEndpoint.Id),
			State:         pulumi.StringRef(sqlEndpointState),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;

return await Deployment.RunAsync(() => 
{
    var testSqlEndpoints = Oci.DataFlow.GetSqlEndpoints.Invoke(new()
    {
        CompartmentId = compartmentId,
        DisplayName = sqlEndpointDisplayName,
        SqlEndpointId = testSqlEndpoint.Id,
        State = sqlEndpointState,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.DataFlow.DataFlowFunctions;
import com.pulumi.oci.DataFlow.inputs.GetSqlEndpointsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var testSqlEndpoints = DataFlowFunctions.getSqlEndpoints(GetSqlEndpointsArgs.builder()
            .compartmentId(compartmentId)
            .displayName(sqlEndpointDisplayName)
            .sqlEndpointId(testSqlEndpoint.id())
            .state(sqlEndpointState)
            .build());

    }
}

    variables:
  testSqlEndpoints:
    fn::invoke:
      Function: oci:DataFlow:getSqlEndpoints
      Arguments:
        compartmentId: ${compartmentId}
        displayName: ${sqlEndpointDisplayName}
        sqlEndpointId: ${testSqlEndpoint.id}
        state: ${sqlEndpointState}

    Using getSqlEndpoints

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getSqlEndpoints(args: GetSqlEndpointsArgs, opts?: InvokeOptions): Promise<GetSqlEndpointsResult>
function getSqlEndpointsOutput(args: GetSqlEndpointsOutputArgs, opts?: InvokeOptions): Output<GetSqlEndpointsResult>
    def get_sql_endpoints(compartment_id: Optional[str] = None,
                      display_name: Optional[str] = None,
                      filters: Optional[Sequence[_dataflow.GetSqlEndpointsFilter]] = None,
                      sql_endpoint_id: Optional[str] = None,
                      state: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetSqlEndpointsResult
def get_sql_endpoints_output(compartment_id: Optional[pulumi.Input[str]] = None,
                      display_name: Optional[pulumi.Input[str]] = None,
                      filters: Optional[pulumi.Input[Sequence[pulumi.Input[_dataflow.GetSqlEndpointsFilterArgs]]]] = None,
                      sql_endpoint_id: Optional[pulumi.Input[str]] = None,
                      state: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetSqlEndpointsResult]
    func GetSqlEndpoints(ctx *Context, args *GetSqlEndpointsArgs, opts ...InvokeOption) (*GetSqlEndpointsResult, error)
func GetSqlEndpointsOutput(ctx *Context, args *GetSqlEndpointsOutputArgs, opts ...InvokeOption) GetSqlEndpointsResultOutput

    > Note: This function is named GetSqlEndpoints in the Go SDK.

    public static class GetSqlEndpoints 
{
    public static Task<GetSqlEndpointsResult> InvokeAsync(GetSqlEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetSqlEndpointsResult> Invoke(GetSqlEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetSqlEndpointsResult> getSqlEndpoints(GetSqlEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:DataFlow/getSqlEndpoints:getSqlEndpoints
  arguments:
    # arguments dictionary

    The following arguments are supported:

    CompartmentId string
    The OCID of the compartment in which to query resources.
    DisplayName string
    The query parameter for the Spark application name.
    Filters List<GetSqlEndpointsFilter>
    SqlEndpointId string
    The unique id of the SQL Endpoint.
    State string
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    CompartmentId string
    The OCID of the compartment in which to query resources.
    DisplayName string
    The query parameter for the Spark application name.
    Filters []GetSqlEndpointsFilter
    SqlEndpointId string
    The unique id of the SQL Endpoint.
    State string
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    compartmentId String
    The OCID of the compartment in which to query resources.
    displayName String
    The query parameter for the Spark application name.
    filters List<GetSqlEndpointsFilter>
    sqlEndpointId String
    The unique id of the SQL Endpoint.
    state String
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    compartmentId string
    The OCID of the compartment in which to query resources.
    displayName string
    The query parameter for the Spark application name.
    filters GetSqlEndpointsFilter[]
    sqlEndpointId string
    The unique id of the SQL Endpoint.
    state string
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    compartment_id str
    The OCID of the compartment in which to query resources.
    display_name str
    The query parameter for the Spark application name.
    filters Sequence[dataflow.GetSqlEndpointsFilter]
    sql_endpoint_id str
    The unique id of the SQL Endpoint.
    state str
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    compartmentId String
    The OCID of the compartment in which to query resources.
    displayName String
    The query parameter for the Spark application name.
    filters List<Property Map>
    sqlEndpointId String
    The unique id of the SQL Endpoint.
    state String
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.

    getSqlEndpoints Result

    The following output properties are available:

    Id string
    The provider-assigned unique ID for this managed resource.
    SqlEndpointCollections List<GetSqlEndpointsSqlEndpointCollection>
    The list of sql_endpoint_collection.
    CompartmentId string
    The OCID of a compartment.
    DisplayName string
    The SQL Endpoint name, which can be changed.
    Filters List<GetSqlEndpointsFilter>
    SqlEndpointId string
    State string
    The current state of the Sql Endpoint.
    Id string
    The provider-assigned unique ID for this managed resource.
    SqlEndpointCollections []GetSqlEndpointsSqlEndpointCollection
    The list of sql_endpoint_collection.
    CompartmentId string
    The OCID of a compartment.
    DisplayName string
    The SQL Endpoint name, which can be changed.
    Filters []GetSqlEndpointsFilter
    SqlEndpointId string
    State string
    The current state of the Sql Endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    sqlEndpointCollections List<GetSqlEndpointsSqlEndpointCollection>
    The list of sql_endpoint_collection.
    compartmentId String
    The OCID of a compartment.
    displayName String
    The SQL Endpoint name, which can be changed.
    filters List<GetSqlEndpointsFilter>
    sqlEndpointId String
    state String
    The current state of the Sql Endpoint.
    id string
    The provider-assigned unique ID for this managed resource.
    sqlEndpointCollections GetSqlEndpointsSqlEndpointCollection[]
    The list of sql_endpoint_collection.
    compartmentId string
    The OCID of a compartment.
    displayName string
    The SQL Endpoint name, which can be changed.
    filters GetSqlEndpointsFilter[]
    sqlEndpointId string
    state string
    The current state of the Sql Endpoint.
    id str
    The provider-assigned unique ID for this managed resource.
    sql_endpoint_collections Sequence[dataflow.GetSqlEndpointsSqlEndpointCollection]
    The list of sql_endpoint_collection.
    compartment_id str
    The OCID of a compartment.
    display_name str
    The SQL Endpoint name, which can be changed.
    filters Sequence[dataflow.GetSqlEndpointsFilter]
    sql_endpoint_id str
    state str
    The current state of the Sql Endpoint.
    id String
    The provider-assigned unique ID for this managed resource.
    sqlEndpointCollections List<Property Map>
    The list of sql_endpoint_collection.
    compartmentId String
    The OCID of a compartment.
    displayName String
    The SQL Endpoint name, which can be changed.
    filters List<Property Map>
    sqlEndpointId String
    state String
    The current state of the Sql Endpoint.

    Supporting Types

    GetSqlEndpointsFilter

    Name string
    Values List<string>
    Regex bool
    Name string
    Values []string
    Regex bool
    name String
    values List<String>
    regex Boolean
    name string
    values string[]
    regex boolean
    name str
    values Sequence[str]
    regex bool
    name String
    values List<String>
    regex Boolean

    GetSqlEndpointsSqlEndpointCollection

    GetSqlEndpointsSqlEndpointCollectionItem

    CompartmentId string
    The OCID of the compartment in which to query resources.
    DefinedTags Dictionary<string, string>
    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 the SQL Endpoint.
    DisplayName string
    The query parameter for the Spark application name.
    DriverShape string
    The shape of the SQL Endpoint driver instance.
    DriverShapeConfigs List<GetSqlEndpointsSqlEndpointCollectionItemDriverShapeConfig>
    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 executor instance.
    ExecutorShapeConfigs List<GetSqlEndpointsSqlEndpointCollectionItemExecutorShapeConfig>
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    FreeformTags Dictionary<string, string>
    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"}
    Id string
    The provision identifier that is immutable on creation.
    JdbcEndpointUrl string
    The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
    LakeId string
    The OCID of Oracle Cloud Infrastructure Lake.
    MaxExecutorCount int
    The maximum number of executors.
    MetastoreId string
    The OCID of Oracle Cloud Infrastructure Hive Metastore.
    MinExecutorCount int
    The minimum number of executors.
    NetworkConfigurations List<GetSqlEndpointsSqlEndpointCollectionItemNetworkConfiguration>
    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 SQL Endpoint.
    State string
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    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.
    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
    CompartmentId string
    The OCID of the compartment in which to query resources.
    DefinedTags map[string]string
    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 the SQL Endpoint.
    DisplayName string
    The query parameter for the Spark application name.
    DriverShape string
    The shape of the SQL Endpoint driver instance.
    DriverShapeConfigs []GetSqlEndpointsSqlEndpointCollectionItemDriverShapeConfig
    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 executor instance.
    ExecutorShapeConfigs []GetSqlEndpointsSqlEndpointCollectionItemExecutorShapeConfig
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    FreeformTags map[string]string
    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"}
    Id string
    The provision identifier that is immutable on creation.
    JdbcEndpointUrl string
    The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
    LakeId string
    The OCID of Oracle Cloud Infrastructure Lake.
    MaxExecutorCount int
    The maximum number of executors.
    MetastoreId string
    The OCID of Oracle Cloud Infrastructure Hive Metastore.
    MinExecutorCount int
    The minimum number of executors.
    NetworkConfigurations []GetSqlEndpointsSqlEndpointCollectionItemNetworkConfiguration
    The network configuration of a SQL Endpoint.
    SparkAdvancedConfigurations map[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 SQL Endpoint.
    State string
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    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 map[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.
    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
    compartmentId String
    The OCID of the compartment in which to query resources.
    definedTags Map<String,String>
    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 the SQL Endpoint.
    displayName String
    The query parameter for the Spark application name.
    driverShape String
    The shape of the SQL Endpoint driver instance.
    driverShapeConfigs List<GetSqlEndpointsSqlEndpointCollectionItemDriverShapeConfig>
    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 executor instance.
    executorShapeConfigs List<GetSqlEndpointsSqlEndpointCollectionItemExecutorShapeConfig>
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    freeformTags Map<String,String>
    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"}
    id String
    The provision identifier that is immutable on creation.
    jdbcEndpointUrl String
    The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
    lakeId String
    The OCID of Oracle Cloud Infrastructure Lake.
    maxExecutorCount Integer
    The maximum number of executors.
    metastoreId String
    The OCID of Oracle Cloud Infrastructure Hive Metastore.
    minExecutorCount Integer
    The minimum number of executors.
    networkConfigurations List<GetSqlEndpointsSqlEndpointCollectionItemNetworkConfiguration>
    The network configuration of a SQL Endpoint.
    sparkAdvancedConfigurations Map<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 SQL Endpoint.
    state String
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    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 Map<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.
    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
    compartmentId string
    The OCID of the compartment in which to query resources.
    definedTags {[key: string]: string}
    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 the SQL Endpoint.
    displayName string
    The query parameter for the Spark application name.
    driverShape string
    The shape of the SQL Endpoint driver instance.
    driverShapeConfigs GetSqlEndpointsSqlEndpointCollectionItemDriverShapeConfig[]
    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 executor instance.
    executorShapeConfigs GetSqlEndpointsSqlEndpointCollectionItemExecutorShapeConfig[]
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    freeformTags {[key: string]: string}
    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"}
    id string
    The provision identifier that is immutable on creation.
    jdbcEndpointUrl string
    The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
    lakeId string
    The OCID of Oracle Cloud Infrastructure Lake.
    maxExecutorCount number
    The maximum number of executors.
    metastoreId string
    The OCID of Oracle Cloud Infrastructure Hive Metastore.
    minExecutorCount number
    The minimum number of executors.
    networkConfigurations GetSqlEndpointsSqlEndpointCollectionItemNetworkConfiguration[]
    The network configuration of a SQL Endpoint.
    sparkAdvancedConfigurations {[key: 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 SQL Endpoint.
    state string
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    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 {[key: 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.
    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
    compartment_id str
    The OCID of the compartment in which to query resources.
    defined_tags Mapping[str, str]
    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 the SQL Endpoint.
    display_name str
    The query parameter for the Spark application name.
    driver_shape str
    The shape of the SQL Endpoint driver instance.
    driver_shape_configs Sequence[dataflow.GetSqlEndpointsSqlEndpointCollectionItemDriverShapeConfig]
    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 executor instance.
    executor_shape_configs Sequence[dataflow.GetSqlEndpointsSqlEndpointCollectionItemExecutorShapeConfig]
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    freeform_tags Mapping[str, str]
    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"}
    id str
    The provision identifier that is immutable on creation.
    jdbc_endpoint_url str
    The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
    lake_id str
    The OCID of Oracle Cloud Infrastructure Lake.
    max_executor_count int
    The maximum number of executors.
    metastore_id str
    The OCID of Oracle Cloud Infrastructure Hive Metastore.
    min_executor_count int
    The minimum number of executors.
    network_configurations Sequence[dataflow.GetSqlEndpointsSqlEndpointCollectionItemNetworkConfiguration]
    The network configuration of a SQL Endpoint.
    spark_advanced_configurations Mapping[str, str]
    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.
    sql_endpoint_version str
    The version of SQL Endpoint.
    state str
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    state_message str
    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.
    system_tags Mapping[str, str]
    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}}
    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
    compartmentId String
    The OCID of the compartment in which to query resources.
    definedTags Map<String>
    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 the SQL Endpoint.
    displayName String
    The query parameter for the Spark application name.
    driverShape String
    The shape of the SQL Endpoint driver instance.
    driverShapeConfigs List<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 executor instance.
    executorShapeConfigs List<Property Map>
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    freeformTags Map<String>
    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"}
    id String
    The provision identifier that is immutable on creation.
    jdbcEndpointUrl String
    The JDBC URL field. For example, jdbc:spark://{serviceFQDN}:443/default;SparkServerType=DFI
    lakeId String
    The OCID of Oracle Cloud Infrastructure Lake.
    maxExecutorCount Number
    The maximum number of executors.
    metastoreId String
    The OCID of Oracle Cloud Infrastructure Hive Metastore.
    minExecutorCount Number
    The minimum number of executors.
    networkConfigurations List<Property Map>
    The network configuration of a SQL Endpoint.
    sparkAdvancedConfigurations Map<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 SQL Endpoint.
    state String
    A filter to return only those resources whose sqlEndpointLifecycleState matches the given sqlEndpointLifecycleState.
    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 Map<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.
    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

    GetSqlEndpointsSqlEndpointCollectionItemDriverShapeConfig

    MemoryInGbs double
    The amount of memory used for the driver or executors.
    Ocpus double
    The total number of OCPUs used for the driver or executors. See here for details.
    MemoryInGbs float64
    The amount of memory used for the driver or executors.
    Ocpus float64
    The total number of OCPUs used for the driver or executors. See here for details.
    memoryInGbs Double
    The amount of memory used for the driver or executors.
    ocpus Double
    The total number of OCPUs used for the driver or executors. See here for details.
    memoryInGbs number
    The amount of memory used for the driver or executors.
    ocpus number
    The total number of OCPUs used for the driver or executors. See here for details.
    memory_in_gbs float
    The amount of memory used for the driver or executors.
    ocpus float
    The total number of OCPUs used for the driver or executors. See here for details.
    memoryInGbs Number
    The amount of memory used for the driver or executors.
    ocpus Number
    The total number of OCPUs used for the driver or executors. See here for details.

    GetSqlEndpointsSqlEndpointCollectionItemExecutorShapeConfig

    MemoryInGbs double
    The amount of memory used for the driver or executors.
    Ocpus double
    The total number of OCPUs used for the driver or executors. See here for details.
    MemoryInGbs float64
    The amount of memory used for the driver or executors.
    Ocpus float64
    The total number of OCPUs used for the driver or executors. See here for details.
    memoryInGbs Double
    The amount of memory used for the driver or executors.
    ocpus Double
    The total number of OCPUs used for the driver or executors. See here for details.
    memoryInGbs number
    The amount of memory used for the driver or executors.
    ocpus number
    The total number of OCPUs used for the driver or executors. See here for details.
    memory_in_gbs float
    The amount of memory used for the driver or executors.
    ocpus float
    The total number of OCPUs used for the driver or executors. See here for details.
    memoryInGbs Number
    The amount of memory used for the driver or executors.
    ocpus Number
    The total number of OCPUs used for the driver or executors. See here for details.

    GetSqlEndpointsSqlEndpointCollectionItemNetworkConfiguration

    AccessControlRules List<GetSqlEndpointsSqlEndpointCollectionItemNetworkConfigurationAccessControlRule>
    A list of SecureAccessControlRule's to which access is limited to
    HostNamePrefix string
    The host name prefix.
    NetworkType string
    The type of network configuration.
    PrivateEndpointIp string
    Ip Address of private endpoint
    PublicEndpointIp string
    Ip Address of public endpoint
    SubnetId string
    The VCN Subnet OCID.
    VcnId string
    The VCN OCID.
    AccessControlRules []GetSqlEndpointsSqlEndpointCollectionItemNetworkConfigurationAccessControlRule
    A list of SecureAccessControlRule's to which access is limited to
    HostNamePrefix string
    The host name prefix.
    NetworkType string
    The type of network configuration.
    PrivateEndpointIp string
    Ip Address of private endpoint
    PublicEndpointIp string
    Ip Address of public endpoint
    SubnetId string
    The VCN Subnet OCID.
    VcnId string
    The VCN OCID.
    accessControlRules List<GetSqlEndpointsSqlEndpointCollectionItemNetworkConfigurationAccessControlRule>
    A list of SecureAccessControlRule's to which access is limited to
    hostNamePrefix String
    The host name prefix.
    networkType String
    The type of network configuration.
    privateEndpointIp String
    Ip Address of private endpoint
    publicEndpointIp String
    Ip Address of public endpoint
    subnetId String
    The VCN Subnet OCID.
    vcnId String
    The VCN OCID.
    accessControlRules GetSqlEndpointsSqlEndpointCollectionItemNetworkConfigurationAccessControlRule[]
    A list of SecureAccessControlRule's to which access is limited to
    hostNamePrefix string
    The host name prefix.
    networkType string
    The type of network configuration.
    privateEndpointIp string
    Ip Address of private endpoint
    publicEndpointIp string
    Ip Address of public endpoint
    subnetId string
    The VCN Subnet OCID.
    vcnId string
    The VCN OCID.
    access_control_rules Sequence[dataflow.GetSqlEndpointsSqlEndpointCollectionItemNetworkConfigurationAccessControlRule]
    A list of SecureAccessControlRule's to which access is limited to
    host_name_prefix str
    The host name prefix.
    network_type str
    The type of network configuration.
    private_endpoint_ip str
    Ip Address of private endpoint
    public_endpoint_ip str
    Ip Address of public endpoint
    subnet_id str
    The VCN Subnet OCID.
    vcn_id str
    The VCN OCID.
    accessControlRules List<Property Map>
    A list of SecureAccessControlRule's to which access is limited to
    hostNamePrefix String
    The host name prefix.
    networkType String
    The type of network configuration.
    privateEndpointIp String
    Ip Address of private endpoint
    publicEndpointIp String
    Ip Address of public endpoint
    subnetId String
    The VCN Subnet OCID.
    vcnId String
    The VCN OCID.

    GetSqlEndpointsSqlEndpointCollectionItemNetworkConfigurationAccessControlRule

    IpNotation string
    The type of IP notation.
    Value string
    The associated value of the selected IP notation.
    VcnIps string
    A comma-separated IP or CIDR address for VCN OCID IP notation selection.
    IpNotation string
    The type of IP notation.
    Value string
    The associated value of the selected IP notation.
    VcnIps string
    A comma-separated IP or CIDR address for VCN OCID IP notation selection.
    ipNotation String
    The type of IP notation.
    value String
    The associated value of the selected IP notation.
    vcnIps String
    A comma-separated IP or CIDR address for VCN OCID IP notation selection.
    ipNotation string
    The type of IP notation.
    value string
    The associated value of the selected IP notation.
    vcnIps string
    A comma-separated IP or CIDR address for VCN OCID IP notation selection.
    ip_notation str
    The type of IP notation.
    value str
    The associated value of the selected IP notation.
    vcn_ips str
    A comma-separated IP or CIDR address for VCN OCID IP notation selection.
    ipNotation String
    The type of IP notation.
    value String
    The associated value of the selected IP notation.
    vcnIps String
    A comma-separated IP or CIDR address for VCN OCID IP notation selection.

    Package Details

    Repository
    oci pulumi/pulumi-oci
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the oci Terraform Provider.
    oci logo
    Oracle Cloud Infrastructure v2.17.0 published on Friday, Nov 15, 2024 by Pulumi
    pulumi/pulumi-oci