Oracle Cloud Infrastructure v2.19.0 published on Thursday, Dec 12, 2024 by Pulumi
oci.Streaming.getStreamPool
Explore with Pulumi AI
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:
- Stream
Pool stringId - The OCID of the stream pool.
- Stream
Pool stringId - The OCID of the stream pool.
- stream
Pool StringId - The OCID of the stream pool.
- stream
Pool stringId - The OCID of the stream pool.
- stream_
pool_ strid - The OCID of the stream pool.
- stream
Pool StringId - The OCID of the stream pool.
getStreamPool Result
The following output properties are available:
- Compartment
Id string - Compartment OCID that the pool belongs to.
- Custom
Encryption List<GetKeys Stream Pool Custom Encryption Key> - Custom Encryption Key which will be used for encryption by all the streams in the pool.
- 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"}}'
- Endpoint
Fqdn 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.
- 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.
- 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 List<GetStream Pool Kafka Setting> - Settings for the Kafka compatibility layer.
- Lifecycle
State stringDetails - Any additional details about the current state of the stream.
- Name string
- The name of the stream pool.
- Private
Endpoint List<GetSettings Stream Pool Private Endpoint Setting> - Optional settings if the stream pool is private.
- State string
- The current state of the stream pool.
- Stream
Pool stringId - Time
Created 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 string - Compartment OCID that the pool belongs to.
- Custom
Encryption []GetKeys Stream Pool Custom Encryption Key - Custom Encryption Key which will be used for encryption by all the streams in the pool.
- 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"}}'
- Endpoint
Fqdn 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.
- 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.
- 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 []GetStream Pool Kafka Setting - Settings for the Kafka compatibility layer.
- Lifecycle
State stringDetails - Any additional details about the current state of the stream.
- Name string
- The name of the stream pool.
- Private
Endpoint []GetSettings Stream Pool Private Endpoint Setting - Optional settings if the stream pool is private.
- State string
- The current state of the stream pool.
- Stream
Pool stringId - Time
Created 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 String - Compartment OCID that the pool belongs to.
- custom
Encryption List<GetKeys Stream Pool Custom Encryption Key> - Custom Encryption Key which will be used for encryption by all the streams in the pool.
- 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"}}'
- endpoint
Fqdn 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.
- 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.
- is
Private 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.
- kafka
Settings List<GetStream Pool Kafka Setting> - Settings for the Kafka compatibility layer.
- lifecycle
State StringDetails - Any additional details about the current state of the stream.
- name String
- The name of the stream pool.
- private
Endpoint List<GetSettings Stream Pool Private Endpoint Setting> - Optional settings if the stream pool is private.
- state String
- The current state of the stream pool.
- stream
Pool StringId - time
Created 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 string - Compartment OCID that the pool belongs to.
- custom
Encryption GetKeys Stream Pool Custom Encryption Key[] - Custom Encryption Key which will be used for encryption by all the streams in the pool.
- {[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"}}'
- endpoint
Fqdn 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.
- {[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.
- is
Private 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.
- kafka
Settings GetStream Pool Kafka Setting[] - Settings for the Kafka compatibility layer.
- lifecycle
State stringDetails - Any additional details about the current state of the stream.
- name string
- The name of the stream pool.
- private
Endpoint GetSettings Stream Pool Private Endpoint Setting[] - Optional settings if the stream pool is private.
- state string
- The current state of the stream pool.
- stream
Pool stringId - time
Created 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_ Sequence[streaming.keys Get Stream Pool Custom Encryption Key] - Custom Encryption Key which will be used for encryption by all the streams in the pool.
- 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.
- 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.Get Stream Pool Kafka Setting] - Settings for the Kafka compatibility layer.
- lifecycle_
state_ strdetails - Any additional details about the current state of the stream.
- name str
- The name of the stream pool.
- private_
endpoint_ Sequence[streaming.settings Get Stream Pool Private Endpoint Setting] - Optional settings if the stream pool is private.
- state str
- The current state of the stream pool.
- stream_
pool_ strid - 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
- compartment
Id String - Compartment OCID that the pool belongs to.
- custom
Encryption List<Property Map>Keys - Custom Encryption Key which will be used for encryption by all the streams in the pool.
- 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"}}'
- endpoint
Fqdn 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.
- 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.
- is
Private 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.
- kafka
Settings List<Property Map> - Settings for the Kafka compatibility layer.
- lifecycle
State StringDetails - Any additional details about the current state of the stream.
- name String
- The name of the stream pool.
- private
Endpoint List<Property Map>Settings - Optional settings if the stream pool is private.
- state String
- The current state of the stream pool.
- stream
Pool StringId - time
Created 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
- key_
state str - Life cycle State of the custom key
- kms_
key_ strid - Custom Encryption Key (Master Key) ocid.
GetStreamPoolKafkaSetting
- Auto
Create boolTopics Enable - Enable auto creation of topic on the server.
- Bootstrap
Servers string - Bootstrap servers.
- Log
Retention intHours - 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.
- Auto
Create boolTopics Enable - Enable auto creation of topic on the server.
- Bootstrap
Servers string - Bootstrap servers.
- Log
Retention intHours - 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.
- auto
Create BooleanTopics Enable - Enable auto creation of topic on the server.
- bootstrap
Servers String - Bootstrap servers.
- log
Retention IntegerHours - The number of hours to keep a log file before deleting it (in hours).
- num
Partitions Integer - The default number of log partitions per topic.
- auto
Create booleanTopics Enable - Enable auto creation of topic on the server.
- bootstrap
Servers string - Bootstrap servers.
- log
Retention numberHours - The number of hours to keep a log file before deleting it (in hours).
- num
Partitions number - The default number of log partitions per topic.
- auto_
create_ booltopics_ enable - Enable auto creation of topic on the server.
- bootstrap_
servers str - Bootstrap servers.
- log_
retention_ inthours - 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.
- auto
Create BooleanTopics Enable - Enable auto creation of topic on the server.
- bootstrap
Servers String - Bootstrap servers.
- log
Retention NumberHours - The number of hours to keep a log file before deleting it (in hours).
- num
Partitions Number - The default number of log partitions per topic.
GetStreamPoolPrivateEndpointSetting
- Nsg
Ids List<string> - The optional list of network security groups that are associated with the private endpoint of the stream pool.
- Private
Endpoint stringIp - 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 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 []string - The optional list of network security groups that are associated with the private endpoint of the stream pool.
- Private
Endpoint stringIp - 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 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 List<String> - The optional list of network security groups that are associated with the private endpoint of the stream pool.
- private
Endpoint StringIp - 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 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 string[] - The optional list of network security groups that are associated with the private endpoint of the stream pool.
- private
Endpoint stringIp - 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 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_ strip - 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.
- nsg
Ids List<String> - The optional list of network security groups that are associated with the private endpoint of the stream pool.
- private
Endpoint StringIp - 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 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.