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

oci.DataFlow.SqlEndpoint

Explore with Pulumi AI

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

    This resource provides the Sql Endpoint resource in Oracle Cloud Infrastructure Data Flow service.

    Note

    Resource Discovery is not supported for this resource.

    Create a new Sql Endpoint.

    Example Usage

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    resources:
  testSqlEndpoint:
    type: oci:DataFlow:SqlEndpoint
    name: test_sql_endpoint
    properties:
      compartmentId: ${compartmentId}
      displayName: ${sqlEndpointDisplayName}
      driverShape: ${sqlEndpointDriverShape}
      executorShape: ${sqlEndpointExecutorShape}
      lakeId: ${testLake.id}
      maxExecutorCount: ${sqlEndpointMaxExecutorCount}
      metastoreId: ${testMetastore.id}
      minExecutorCount: ${sqlEndpointMinExecutorCount}
      networkConfiguration:
        networkType: ${sqlEndpointNetworkConfigurationNetworkType}
        accessControlRules:
          - ipNotation: ${sqlEndpointNetworkConfigurationAccessControlRulesIpNotation}
            value: ${sqlEndpointNetworkConfigurationAccessControlRulesValue}
            vcnIps: ${sqlEndpointNetworkConfigurationAccessControlRulesVcnIps}
        hostNamePrefix: ${sqlEndpointNetworkConfigurationHostNamePrefix}
        nsgIds: ${sqlEndpointNetworkConfigurationNsgIds}
        privateEndpointIp: ${sqlEndpointNetworkConfigurationPrivateEndpointIp}
        publicEndpointIp: ${sqlEndpointNetworkConfigurationPublicEndpointIp}
        subnetId: ${testSubnet.id}
        vcnId: ${testVcn.id}
      sqlEndpointVersion: ${sqlEndpointSqlEndpointVersion}
      warehouseBucketUri: ${sqlEndpointWarehouseBucketUri}
      definedTags:
        Operations.CostCenter: '42'
      description: ${sqlEndpointDescription}
      driverShapeConfig:
        memoryInGbs: ${sqlEndpointDriverShapeConfigMemoryInGbs}
        ocpus: ${sqlEndpointDriverShapeConfigOcpus}
      executorShapeConfig:
        memoryInGbs: ${sqlEndpointExecutorShapeConfigMemoryInGbs}
        ocpus: ${sqlEndpointExecutorShapeConfigOcpus}
      freeformTags:
        Department: Finance
      sparkAdvancedConfigurations: ${sqlEndpointSparkAdvancedConfigurations}

    Create SqlEndpoint Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new SqlEndpoint(name: string, args: SqlEndpointArgs, opts?: CustomResourceOptions);
    @overload
def SqlEndpoint(resource_name: str,
                args: SqlEndpointArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def SqlEndpoint(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                network_configuration: Optional[_dataflow.SqlEndpointNetworkConfigurationArgs] = None,
                metastore_id: Optional[str] = None,
                sql_endpoint_version: Optional[str] = None,
                display_name: Optional[str] = None,
                compartment_id: Optional[str] = None,
                min_executor_count: Optional[int] = None,
                max_executor_count: Optional[int] = None,
                executor_shape: Optional[str] = None,
                driver_shape: Optional[str] = None,
                defined_tags: Optional[Mapping[str, str]] = None,
                executor_shape_config: Optional[_dataflow.SqlEndpointExecutorShapeConfigArgs] = None,
                driver_shape_config: Optional[_dataflow.SqlEndpointDriverShapeConfigArgs] = None,
                freeform_tags: Optional[Mapping[str, str]] = None,
                spark_advanced_configurations: Optional[Mapping[str, str]] = None,
                description: Optional[str] = None,
                state: Optional[str] = None)
    func NewSqlEndpoint(ctx *Context, name string, args SqlEndpointArgs, opts ...ResourceOption) (*SqlEndpoint, error)
    public SqlEndpoint(string name, SqlEndpointArgs args, CustomResourceOptions? opts = null)
    public SqlEndpoint(String name, SqlEndpointArgs args)
public SqlEndpoint(String name, SqlEndpointArgs args, CustomResourceOptions options)

    type: oci:DataFlow:SqlEndpoint
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SqlEndpointArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var sqlEndpointResource = new Oci.DataFlow.SqlEndpoint("sqlEndpointResource", new()
{
    NetworkConfiguration = new Oci.DataFlow.Inputs.SqlEndpointNetworkConfigurationArgs
    {
        NetworkType = "string",
        AccessControlRules = new[]
        {
            new Oci.DataFlow.Inputs.SqlEndpointNetworkConfigurationAccessControlRuleArgs
            {
                IpNotation = "string",
                Value = "string",
                VcnIps = "string",
            },
        },
        HostNamePrefix = "string",
        PrivateEndpointIp = "string",
        PublicEndpointIp = "string",
        SubnetId = "string",
        VcnId = "string",
    },
    MetastoreId = "string",
    SqlEndpointVersion = "string",
    DisplayName = "string",
    CompartmentId = "string",
    MinExecutorCount = 0,
    MaxExecutorCount = 0,
    ExecutorShape = "string",
    DriverShape = "string",
    DefinedTags = 
    {
        { "string", "string" },
    },
    ExecutorShapeConfig = new Oci.DataFlow.Inputs.SqlEndpointExecutorShapeConfigArgs
    {
        MemoryInGbs = 0,
        Ocpus = 0,
    },
    DriverShapeConfig = new Oci.DataFlow.Inputs.SqlEndpointDriverShapeConfigArgs
    {
        MemoryInGbs = 0,
        Ocpus = 0,
    },
    FreeformTags = 
    {
        { "string", "string" },
    },
    SparkAdvancedConfigurations = 
    {
        { "string", "string" },
    },
    Description = "string",
    State = "string",
});

    example, err := DataFlow.NewSqlEndpoint(ctx, "sqlEndpointResource", &DataFlow.SqlEndpointArgs{
	NetworkConfiguration: &dataflow.SqlEndpointNetworkConfigurationArgs{
		NetworkType: pulumi.String("string"),
		AccessControlRules: dataflow.SqlEndpointNetworkConfigurationAccessControlRuleArray{
			&dataflow.SqlEndpointNetworkConfigurationAccessControlRuleArgs{
				IpNotation: pulumi.String("string"),
				Value:      pulumi.String("string"),
				VcnIps:     pulumi.String("string"),
			},
		},
		HostNamePrefix:    pulumi.String("string"),
		PrivateEndpointIp: pulumi.String("string"),
		PublicEndpointIp:  pulumi.String("string"),
		SubnetId:          pulumi.String("string"),
		VcnId:             pulumi.String("string"),
	},
	MetastoreId:        pulumi.String("string"),
	SqlEndpointVersion: pulumi.String("string"),
	DisplayName:        pulumi.String("string"),
	CompartmentId:      pulumi.String("string"),
	MinExecutorCount:   pulumi.Int(0),
	MaxExecutorCount:   pulumi.Int(0),
	ExecutorShape:      pulumi.String("string"),
	DriverShape:        pulumi.String("string"),
	DefinedTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	ExecutorShapeConfig: &dataflow.SqlEndpointExecutorShapeConfigArgs{
		MemoryInGbs: pulumi.Float64(0),
		Ocpus:       pulumi.Float64(0),
	},
	DriverShapeConfig: &dataflow.SqlEndpointDriverShapeConfigArgs{
		MemoryInGbs: pulumi.Float64(0),
		Ocpus:       pulumi.Float64(0),
	},
	FreeformTags: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	SparkAdvancedConfigurations: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Description: pulumi.String("string"),
	State:       pulumi.String("string"),
})

    var sqlEndpointResource = new SqlEndpoint("sqlEndpointResource", SqlEndpointArgs.builder()
    .networkConfiguration(SqlEndpointNetworkConfigurationArgs.builder()
        .networkType("string")
        .accessControlRules(SqlEndpointNetworkConfigurationAccessControlRuleArgs.builder()
            .ipNotation("string")
            .value("string")
            .vcnIps("string")
            .build())
        .hostNamePrefix("string")
        .privateEndpointIp("string")
        .publicEndpointIp("string")
        .subnetId("string")
        .vcnId("string")
        .build())
    .metastoreId("string")
    .sqlEndpointVersion("string")
    .displayName("string")
    .compartmentId("string")
    .minExecutorCount(0)
    .maxExecutorCount(0)
    .executorShape("string")
    .driverShape("string")
    .definedTags(Map.of("string", "string"))
    .executorShapeConfig(SqlEndpointExecutorShapeConfigArgs.builder()
        .memoryInGbs(0)
        .ocpus(0)
        .build())
    .driverShapeConfig(SqlEndpointDriverShapeConfigArgs.builder()
        .memoryInGbs(0)
        .ocpus(0)
        .build())
    .freeformTags(Map.of("string", "string"))
    .sparkAdvancedConfigurations(Map.of("string", "string"))
    .description("string")
    .state("string")
    .build());

    sql_endpoint_resource = oci.data_flow.SqlEndpoint("sqlEndpointResource",
    network_configuration={
        "network_type": "string",
        "access_control_rules": [{
            "ip_notation": "string",
            "value": "string",
            "vcn_ips": "string",
        }],
        "host_name_prefix": "string",
        "private_endpoint_ip": "string",
        "public_endpoint_ip": "string",
        "subnet_id": "string",
        "vcn_id": "string",
    },
    metastore_id="string",
    sql_endpoint_version="string",
    display_name="string",
    compartment_id="string",
    min_executor_count=0,
    max_executor_count=0,
    executor_shape="string",
    driver_shape="string",
    defined_tags={
        "string": "string",
    },
    executor_shape_config={
        "memory_in_gbs": 0,
        "ocpus": 0,
    },
    driver_shape_config={
        "memory_in_gbs": 0,
        "ocpus": 0,
    },
    freeform_tags={
        "string": "string",
    },
    spark_advanced_configurations={
        "string": "string",
    },
    description="string",
    state="string")

    const sqlEndpointResource = new oci.dataflow.SqlEndpoint("sqlEndpointResource", {
    networkConfiguration: {
        networkType: "string",
        accessControlRules: [{
            ipNotation: "string",
            value: "string",
            vcnIps: "string",
        }],
        hostNamePrefix: "string",
        privateEndpointIp: "string",
        publicEndpointIp: "string",
        subnetId: "string",
        vcnId: "string",
    },
    metastoreId: "string",
    sqlEndpointVersion: "string",
    displayName: "string",
    compartmentId: "string",
    minExecutorCount: 0,
    maxExecutorCount: 0,
    executorShape: "string",
    driverShape: "string",
    definedTags: {
        string: "string",
    },
    executorShapeConfig: {
        memoryInGbs: 0,
        ocpus: 0,
    },
    driverShapeConfig: {
        memoryInGbs: 0,
        ocpus: 0,
    },
    freeformTags: {
        string: "string",
    },
    sparkAdvancedConfigurations: {
        string: "string",
    },
    description: "string",
    state: "string",
});

    type: oci:DataFlow:SqlEndpoint
properties:
    compartmentId: string
    definedTags:
        string: string
    description: string
    displayName: string
    driverShape: string
    driverShapeConfig:
        memoryInGbs: 0
        ocpus: 0
    executorShape: string
    executorShapeConfig:
        memoryInGbs: 0
        ocpus: 0
    freeformTags:
        string: string
    maxExecutorCount: 0
    metastoreId: string
    minExecutorCount: 0
    networkConfiguration:
        accessControlRules:
            - ipNotation: string
              value: string
              vcnIps: string
        hostNamePrefix: string
        networkType: string
        privateEndpointIp: string
        publicEndpointIp: string
        subnetId: string
        vcnId: string
    sparkAdvancedConfigurations:
        string: string
    sqlEndpointVersion: string
    state: string

    SqlEndpoint Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The SqlEndpoint resource accepts the following input properties:

    CompartmentId string
    (Updatable) The identifier of the compartment used with the SQL Endpoint.
    DisplayName string
    (Updatable) The SQL Endpoint name, which can be changed.
    DriverShape string
    The shape of the SQL Endpoint driver instance.
    ExecutorShape string
    The shape of the SQL Endpoint worker instance.
    MaxExecutorCount int
    (Updatable) The maximum number of executors.
    MetastoreId string
    Metastore OCID
    MinExecutorCount int
    (Updatable) The minimum number of executors.
    NetworkConfiguration SqlEndpointNetworkConfiguration
    The network configuration of a SQL Endpoint.
    SqlEndpointVersion string
    The version of 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
    (Updatable) The description of CreateSQLEndpointDetails.
    DriverShapeConfig SqlEndpointDriverShapeConfig
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    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"}
    SparkAdvancedConfigurations Dictionary<string, string>
    (Updatable) 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.
    State string

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

    ** 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.
    DisplayName string
    (Updatable) The SQL Endpoint name, which can be changed.
    DriverShape string
    The shape of the SQL Endpoint driver instance.
    ExecutorShape string
    The shape of the SQL Endpoint worker instance.
    MaxExecutorCount int
    (Updatable) The maximum number of executors.
    MetastoreId string
    Metastore OCID
    MinExecutorCount int
    (Updatable) The minimum number of executors.
    NetworkConfiguration SqlEndpointNetworkConfigurationArgs
    The network configuration of a SQL Endpoint.
    SqlEndpointVersion string
    The version of 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
    (Updatable) The description of CreateSQLEndpointDetails.
    DriverShapeConfig SqlEndpointDriverShapeConfigArgs
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    ExecutorShapeConfig SqlEndpointExecutorShapeConfigArgs
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    FreeformTags map[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"}
    SparkAdvancedConfigurations map[string]string
    (Updatable) 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.
    State string

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

    ** 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.
    displayName String
    (Updatable) The SQL Endpoint name, which can be changed.
    driverShape String
    The shape of the SQL Endpoint driver instance.
    executorShape String
    The shape of the SQL Endpoint worker instance.
    maxExecutorCount Integer
    (Updatable) The maximum number of executors.
    metastoreId String
    Metastore OCID
    minExecutorCount Integer
    (Updatable) The minimum number of executors.
    networkConfiguration SqlEndpointNetworkConfiguration
    The network configuration of a SQL Endpoint.
    sqlEndpointVersion String
    The version of 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
    (Updatable) The description of CreateSQLEndpointDetails.
    driverShapeConfig SqlEndpointDriverShapeConfig
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    executorShapeConfig SqlEndpointExecutorShapeConfig
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    freeformTags Map<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"}
    sparkAdvancedConfigurations Map<String,String>
    (Updatable) 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.
    state String

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

    ** 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.
    displayName string
    (Updatable) The SQL Endpoint name, which can be changed.
    driverShape string
    The shape of the SQL Endpoint driver instance.
    executorShape string
    The shape of the SQL Endpoint worker instance.
    maxExecutorCount number
    (Updatable) The maximum number of executors.
    metastoreId string
    Metastore OCID
    minExecutorCount number
    (Updatable) The minimum number of executors.
    networkConfiguration SqlEndpointNetworkConfiguration
    The network configuration of a SQL Endpoint.
    sqlEndpointVersion string
    The version of 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
    (Updatable) The description of CreateSQLEndpointDetails.
    driverShapeConfig SqlEndpointDriverShapeConfig
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    executorShapeConfig SqlEndpointExecutorShapeConfig
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    freeformTags {[key: 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"}
    sparkAdvancedConfigurations {[key: string]: string}
    (Updatable) 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.
    state string

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

    ** 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.
    display_name str
    (Updatable) The SQL Endpoint name, which can be changed.
    driver_shape str
    The shape of the SQL Endpoint driver instance.
    executor_shape str
    The shape of the SQL Endpoint worker instance.
    max_executor_count int
    (Updatable) The maximum number of executors.
    metastore_id str
    Metastore OCID
    min_executor_count int
    (Updatable) The minimum number of executors.
    network_configuration dataflow.SqlEndpointNetworkConfigurationArgs
    The network configuration of a SQL Endpoint.
    sql_endpoint_version str
    The version of 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
    (Updatable) The description of CreateSQLEndpointDetails.
    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_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]
    (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"}
    spark_advanced_configurations Mapping[str, str]
    (Updatable) 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.
    state str

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

    ** 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.
    displayName String
    (Updatable) The SQL Endpoint name, which can be changed.
    driverShape String
    The shape of the SQL Endpoint driver instance.
    executorShape String
    The shape of the SQL Endpoint worker instance.
    maxExecutorCount Number
    (Updatable) The maximum number of executors.
    metastoreId String
    Metastore OCID
    minExecutorCount Number
    (Updatable) The minimum number of executors.
    networkConfiguration Property Map
    The network configuration of a SQL Endpoint.
    sqlEndpointVersion String
    The version of 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
    (Updatable) The description of CreateSQLEndpointDetails.
    driverShapeConfig Property Map
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    executorShapeConfig Property Map
    This is used to configure the shape of the driver or executor if a flexible shape is used.
    freeformTags Map<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"}
    sparkAdvancedConfigurations Map<String>
    (Updatable) 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.
    state String

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

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

    Outputs

    All input properties are implicitly available as output properties. Additionally, the SqlEndpoint resource produces the following output properties:

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

    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,
        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
    (Updatable) The description of CreateSQLEndpointDetails.
    DisplayName string
    (Updatable) The SQL Endpoint name, which can be changed.
    DriverShape string
    The shape of the SQL Endpoint driver instance.
    DriverShapeConfig SqlEndpointDriverShapeConfig
    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
    MaxExecutorCount int
    (Updatable) The maximum number of executors.
    MetastoreId string
    Metastore OCID
    MinExecutorCount int
    (Updatable) The minimum number of executors.
    NetworkConfiguration SqlEndpointNetworkConfiguration
    The network configuration of a SQL Endpoint.
    SparkAdvancedConfigurations Dictionary<string, string>
    (Updatable) 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

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

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

    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
    (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
    (Updatable) The description of CreateSQLEndpointDetails.
    DisplayName string
    (Updatable) The SQL Endpoint name, which can be changed.
    DriverShape string
    The shape of the SQL Endpoint driver instance.
    DriverShapeConfig SqlEndpointDriverShapeConfigArgs
    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
    (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
    MaxExecutorCount int
    (Updatable) The maximum number of executors.
    MetastoreId string
    Metastore OCID
    MinExecutorCount int
    (Updatable) The minimum number of executors.
    NetworkConfiguration SqlEndpointNetworkConfigurationArgs
    The network configuration of a SQL Endpoint.
    SparkAdvancedConfigurations map[string]string
    (Updatable) 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

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

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

    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
    (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
    (Updatable) The description of CreateSQLEndpointDetails.
    displayName String
    (Updatable) The SQL Endpoint name, which can be changed.
    driverShape String
    The shape of the SQL Endpoint driver instance.
    driverShapeConfig SqlEndpointDriverShapeConfig
    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>
    (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
    maxExecutorCount Integer
    (Updatable) The maximum number of executors.
    metastoreId String
    Metastore OCID
    minExecutorCount Integer
    (Updatable) The minimum number of executors.
    networkConfiguration SqlEndpointNetworkConfiguration
    The network configuration of a SQL Endpoint.
    sparkAdvancedConfigurations Map<String,String>
    (Updatable) 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

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

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

    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
    (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
    (Updatable) The description of CreateSQLEndpointDetails.
    displayName string
    (Updatable) The SQL Endpoint name, which can be changed.
    driverShape string
    The shape of the SQL Endpoint driver instance.
    driverShapeConfig SqlEndpointDriverShapeConfig
    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}
    (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
    maxExecutorCount number
    (Updatable) The maximum number of executors.
    metastoreId string
    Metastore OCID
    minExecutorCount number
    (Updatable) The minimum number of executors.
    networkConfiguration SqlEndpointNetworkConfiguration
    The network configuration of a SQL Endpoint.
    sparkAdvancedConfigurations {[key: string]: string}
    (Updatable) 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

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

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

    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
    (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
    (Updatable) The description of CreateSQLEndpointDetails.
    display_name str
    (Updatable) 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]
    (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"}
    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
    max_executor_count int
    (Updatable) The maximum number of executors.
    metastore_id str
    Metastore OCID
    min_executor_count int
    (Updatable) The minimum number of executors.
    network_configuration dataflow.SqlEndpointNetworkConfigurationArgs
    The network configuration of a SQL Endpoint.
    spark_advanced_configurations Mapping[str, str]
    (Updatable) 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 the SQL Endpoint.
    state str

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

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

    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
    (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
    (Updatable) The description of CreateSQLEndpointDetails.
    displayName String
    (Updatable) 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>
    (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
    maxExecutorCount Number
    (Updatable) The maximum number of executors.
    metastoreId String
    Metastore OCID
    minExecutorCount Number
    (Updatable) The minimum number of executors.
    networkConfiguration Property Map
    The network configuration of a SQL Endpoint.
    sparkAdvancedConfigurations Map<String>
    (Updatable) 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

    (Updatable) The target state for the Sql Endpoint. Could be set to ACTIVE or INACTIVE.

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

    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

    Supporting Types

    SqlEndpointDriverShapeConfig, SqlEndpointDriverShapeConfigArgs

    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.

    SqlEndpointExecutorShapeConfig, SqlEndpointExecutorShapeConfigArgs

    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.

    SqlEndpointNetworkConfiguration, SqlEndpointNetworkConfigurationArgs

    NetworkType string
    The type of network configuration.
    AccessControlRules List<SqlEndpointNetworkConfigurationAccessControlRule>
    A list of SecureAccessControlRule's to which access is limited to
    HostNamePrefix string
    The host name prefix.
    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.
    NetworkType string
    The type of network configuration.
    AccessControlRules []SqlEndpointNetworkConfigurationAccessControlRule
    A list of SecureAccessControlRule's to which access is limited to
    HostNamePrefix string
    The host name prefix.
    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.
    networkType String
    The type of network configuration.
    accessControlRules List<SqlEndpointNetworkConfigurationAccessControlRule>
    A list of SecureAccessControlRule's to which access is limited to
    hostNamePrefix String
    The host name prefix.
    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.
    networkType string
    The type of network configuration.
    accessControlRules SqlEndpointNetworkConfigurationAccessControlRule[]
    A list of SecureAccessControlRule's to which access is limited to
    hostNamePrefix string
    The host name prefix.
    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.
    network_type str
    The type of network configuration.
    access_control_rules Sequence[dataflow.SqlEndpointNetworkConfigurationAccessControlRule]
    A list of SecureAccessControlRule's to which access is limited to
    host_name_prefix str
    The host name prefix.
    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.
    networkType String
    The type of network configuration.
    accessControlRules List<Property Map>
    A list of SecureAccessControlRule's to which access is limited to
    hostNamePrefix String
    The host name prefix.
    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.

    SqlEndpointNetworkConfigurationAccessControlRule, SqlEndpointNetworkConfigurationAccessControlRuleArgs

    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.

    Import

    SqlEndpoints can be imported using the id, e.g.

    $ pulumi import oci:DataFlow/sqlEndpoint:SqlEndpoint test_sql_endpoint "id"

    To learn more about importing existing cloud resources, see Importing resources.

    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