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

oci.Streaming.getStreamPool

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 details about a specific Stream Pool resource in Oracle Cloud Infrastructure Streaming service.

    Gets detailed information about the stream pool, such as Kafka settings.

    Example Usage

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

const testStreamPool = oci.Streaming.getStreamPool({
    streamPoolId: testStreamPoolOciStreamingStreamPool.id,
});

    import pulumi
import pulumi_oci as oci

test_stream_pool = oci.Streaming.get_stream_pool(stream_pool_id=test_stream_pool_oci_streaming_stream_pool["id"])

    package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := Streaming.GetStreamPool(ctx, &streaming.GetStreamPoolArgs{
			StreamPoolId: testStreamPoolOciStreamingStreamPool.Id,
		}, 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 testStreamPool = Oci.Streaming.GetStreamPool.Invoke(new()
    {
        StreamPoolId = testStreamPoolOciStreamingStreamPool.Id,
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Streaming.StreamingFunctions;
import com.pulumi.oci.Streaming.inputs.GetStreamPoolArgs;
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 testStreamPool = StreamingFunctions.getStreamPool(GetStreamPoolArgs.builder()
            .streamPoolId(testStreamPoolOciStreamingStreamPool.id())
            .build());

    }
}

    variables:
  testStreamPool:
    fn::invoke:
      Function: oci:Streaming:getStreamPool
      Arguments:
        streamPoolId: ${testStreamPoolOciStreamingStreamPool.id}

    Using getStreamPool

    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 getStreamPool(args: GetStreamPoolArgs, opts?: InvokeOptions): Promise<GetStreamPoolResult>
function getStreamPoolOutput(args: GetStreamPoolOutputArgs, opts?: InvokeOptions): Output<GetStreamPoolResult>
    def get_stream_pool(stream_pool_id: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetStreamPoolResult
def get_stream_pool_output(stream_pool_id: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetStreamPoolResult]
    func GetStreamPool(ctx *Context, args *GetStreamPoolArgs, opts ...InvokeOption) (*GetStreamPoolResult, error)
func GetStreamPoolOutput(ctx *Context, args *GetStreamPoolOutputArgs, opts ...InvokeOption) GetStreamPoolResultOutput

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

    public static class GetStreamPool 
{
    public static Task<GetStreamPoolResult> InvokeAsync(GetStreamPoolArgs args, InvokeOptions? opts = null)
    public static Output<GetStreamPoolResult> Invoke(GetStreamPoolInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetStreamPoolResult> getStreamPool(GetStreamPoolArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: oci:Streaming/getStreamPool:getStreamPool
  arguments:
    # arguments dictionary

    The following arguments are supported:

    StreamPoolId string
    The OCID of the stream pool.
    StreamPoolId string
    The OCID of the stream pool.
    streamPoolId String
    The OCID of the stream pool.
    streamPoolId string
    The OCID of the stream pool.
    stream_pool_id str
    The OCID of the stream pool.
    streamPoolId String
    The OCID of the stream pool.

    getStreamPool Result

    The following output properties are available:

    CompartmentId string
    Compartment OCID that the pool belongs to.
    CustomEncryptionKeys List<GetStreamPoolCustomEncryptionKey>
    Custom Encryption Key which will be used for encryption by all the streams in the pool.
    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"}}'
    EndpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    FreeformTags Dictionary<string, string>
    Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the stream pool.
    IsPrivate bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    KafkaSettings List<GetStreamPoolKafkaSetting>
    Settings for the Kafka compatibility layer.
    LifecycleStateDetails string
    Any additional details about the current state of the stream.
    Name string
    The name of the stream pool.
    PrivateEndpointSettings List<GetStreamPoolPrivateEndpointSetting>
    Optional settings if the stream pool is private.
    State string
    The current state of the stream pool.
    StreamPoolId string
    TimeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    CompartmentId string
    Compartment OCID that the pool belongs to.
    CustomEncryptionKeys []GetStreamPoolCustomEncryptionKey
    Custom Encryption Key which will be used for encryption by all the streams in the pool.
    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"}}'
    EndpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    FreeformTags map[string]string
    Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    Id string
    The OCID of the stream pool.
    IsPrivate bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    KafkaSettings []GetStreamPoolKafkaSetting
    Settings for the Kafka compatibility layer.
    LifecycleStateDetails string
    Any additional details about the current state of the stream.
    Name string
    The name of the stream pool.
    PrivateEndpointSettings []GetStreamPoolPrivateEndpointSetting
    Optional settings if the stream pool is private.
    State string
    The current state of the stream pool.
    StreamPoolId string
    TimeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId String
    Compartment OCID that the pool belongs to.
    customEncryptionKeys List<GetStreamPoolCustomEncryptionKey>
    Custom Encryption Key which will be used for encryption by all the streams in the pool.
    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"}}'
    endpointFqdn String
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    freeformTags Map<String,String>
    Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the stream pool.
    isPrivate Boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    kafkaSettings List<GetStreamPoolKafkaSetting>
    Settings for the Kafka compatibility layer.
    lifecycleStateDetails String
    Any additional details about the current state of the stream.
    name String
    The name of the stream pool.
    privateEndpointSettings List<GetStreamPoolPrivateEndpointSetting>
    Optional settings if the stream pool is private.
    state String
    The current state of the stream pool.
    streamPoolId String
    timeCreated String
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId string
    Compartment OCID that the pool belongs to.
    customEncryptionKeys GetStreamPoolCustomEncryptionKey[]
    Custom Encryption Key which will be used for encryption by all the streams in the pool.
    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"}}'
    endpointFqdn string
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    freeformTags {[key: string]: string}
    Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id string
    The OCID of the stream pool.
    isPrivate boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    kafkaSettings GetStreamPoolKafkaSetting[]
    Settings for the Kafka compatibility layer.
    lifecycleStateDetails string
    Any additional details about the current state of the stream.
    name string
    The name of the stream pool.
    privateEndpointSettings GetStreamPoolPrivateEndpointSetting[]
    Optional settings if the stream pool is private.
    state string
    The current state of the stream pool.
    streamPoolId string
    timeCreated string
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartment_id str
    Compartment OCID that the pool belongs to.
    custom_encryption_keys Sequence[streaming.GetStreamPoolCustomEncryptionKey]
    Custom Encryption Key which will be used for encryption by all the streams in the pool.
    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"}}'
    endpoint_fqdn str
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    freeform_tags Mapping[str, str]
    Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id str
    The OCID of the stream pool.
    is_private bool
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    kafka_settings Sequence[streaming.GetStreamPoolKafkaSetting]
    Settings for the Kafka compatibility layer.
    lifecycle_state_details str
    Any additional details about the current state of the stream.
    name str
    The name of the stream pool.
    private_endpoint_settings Sequence[streaming.GetStreamPoolPrivateEndpointSetting]
    Optional settings if the stream pool is private.
    state str
    The current state of the stream pool.
    stream_pool_id str
    time_created str
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z
    compartmentId String
    Compartment OCID that the pool belongs to.
    customEncryptionKeys List<Property Map>
    Custom Encryption Key which will be used for encryption by all the streams in the pool.
    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"}}'
    endpointFqdn String
    The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a Stream object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
    freeformTags Map<String>
    Free-form tags for this resource. Each tag is a simple key-value pair that is applied with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see Resource Tags. Example: {"Department": "Finance"}
    id String
    The OCID of the stream pool.
    isPrivate Boolean
    True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the GetStreamPool API.
    kafkaSettings List<Property Map>
    Settings for the Kafka compatibility layer.
    lifecycleStateDetails String
    Any additional details about the current state of the stream.
    name String
    The name of the stream pool.
    privateEndpointSettings List<Property Map>
    Optional settings if the stream pool is private.
    state String
    The current state of the stream pool.
    streamPoolId String
    timeCreated String
    The date and time the stream pool was created, expressed in in RFC 3339 timestamp format. Example: 2018-04-20T00:00:07.405Z

    Supporting Types

    GetStreamPoolCustomEncryptionKey

    KeyState string
    Life cycle State of the custom key
    KmsKeyId string
    Custom Encryption Key (Master Key) ocid.
    KeyState string
    Life cycle State of the custom key
    KmsKeyId string
    Custom Encryption Key (Master Key) ocid.
    keyState String
    Life cycle State of the custom key
    kmsKeyId String
    Custom Encryption Key (Master Key) ocid.
    keyState string
    Life cycle State of the custom key
    kmsKeyId string
    Custom Encryption Key (Master Key) ocid.
    key_state str
    Life cycle State of the custom key
    kms_key_id str
    Custom Encryption Key (Master Key) ocid.
    keyState String
    Life cycle State of the custom key
    kmsKeyId String
    Custom Encryption Key (Master Key) ocid.

    GetStreamPoolKafkaSetting

    AutoCreateTopicsEnable bool
    Enable auto creation of topic on the server.
    BootstrapServers string
    Bootstrap servers.
    LogRetentionHours int
    The number of hours to keep a log file before deleting it (in hours).
    NumPartitions int
    The default number of log partitions per topic.
    AutoCreateTopicsEnable bool
    Enable auto creation of topic on the server.
    BootstrapServers string
    Bootstrap servers.
    LogRetentionHours int
    The number of hours to keep a log file before deleting it (in hours).
    NumPartitions int
    The default number of log partitions per topic.
    autoCreateTopicsEnable Boolean
    Enable auto creation of topic on the server.
    bootstrapServers String
    Bootstrap servers.
    logRetentionHours Integer
    The number of hours to keep a log file before deleting it (in hours).
    numPartitions Integer
    The default number of log partitions per topic.
    autoCreateTopicsEnable boolean
    Enable auto creation of topic on the server.
    bootstrapServers string
    Bootstrap servers.
    logRetentionHours number
    The number of hours to keep a log file before deleting it (in hours).
    numPartitions number
    The default number of log partitions per topic.
    auto_create_topics_enable bool
    Enable auto creation of topic on the server.
    bootstrap_servers str
    Bootstrap servers.
    log_retention_hours int
    The number of hours to keep a log file before deleting it (in hours).
    num_partitions int
    The default number of log partitions per topic.
    autoCreateTopicsEnable Boolean
    Enable auto creation of topic on the server.
    bootstrapServers String
    Bootstrap servers.
    logRetentionHours Number
    The number of hours to keep a log file before deleting it (in hours).
    numPartitions Number
    The default number of log partitions per topic.

    GetStreamPoolPrivateEndpointSetting

    NsgIds List<string>
    The optional list of network security groups that are associated with the private endpoint of the stream pool.
    PrivateEndpointIp string
    The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.
    SubnetId string
    The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.
    NsgIds []string
    The optional list of network security groups that are associated with the private endpoint of the stream pool.
    PrivateEndpointIp string
    The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.
    SubnetId string
    The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.
    nsgIds List<String>
    The optional list of network security groups that are associated with the private endpoint of the stream pool.
    privateEndpointIp String
    The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.
    subnetId String
    The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.
    nsgIds string[]
    The optional list of network security groups that are associated with the private endpoint of the stream pool.
    privateEndpointIp string
    The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.
    subnetId string
    The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.
    nsg_ids Sequence[str]
    The optional list of network security groups that are associated with the private endpoint of the stream pool.
    private_endpoint_ip str
    The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.
    subnet_id str
    The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.
    nsgIds List<String>
    The optional list of network security groups that are associated with the private endpoint of the stream pool.
    privateEndpointIp String
    The private IP associated with the stream pool in the associated subnetId. The stream pool's FQDN resolves to that IP and should be used - instead of the private IP - in order to not trigger any TLS issues.
    subnetId String
    The subnet id from which the private stream pool can be accessed. Trying to access the streams from another network location will result in an error.

    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