Oracle Cloud Infrastructure v2.18.0 published on Friday, Nov 22, 2024 by Pulumi
oci.Streaming.getStreamPools
Explore with Pulumi AI
This data source provides the list of Stream Pools in Oracle Cloud Infrastructure Streaming service.
List the stream pools for a given compartment ID.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testStreamPools = oci.Streaming.getStreamPools({
compartmentId: compartmentId,
id: streamPoolId,
name: streamPoolName,
state: streamPoolState,
});
import pulumi
import pulumi_oci as oci
test_stream_pools = oci.Streaming.get_stream_pools(compartment_id=compartment_id,
id=stream_pool_id,
name=stream_pool_name,
state=stream_pool_state)
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.GetStreamPools(ctx, &streaming.GetStreamPoolsArgs{
CompartmentId: compartmentId,
Id: pulumi.StringRef(streamPoolId),
Name: pulumi.StringRef(streamPoolName),
State: pulumi.StringRef(streamPoolState),
}, 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 testStreamPools = Oci.Streaming.GetStreamPools.Invoke(new()
{
CompartmentId = compartmentId,
Id = streamPoolId,
Name = streamPoolName,
State = streamPoolState,
});
});
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.GetStreamPoolsArgs;
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 testStreamPools = StreamingFunctions.getStreamPools(GetStreamPoolsArgs.builder()
.compartmentId(compartmentId)
.id(streamPoolId)
.name(streamPoolName)
.state(streamPoolState)
.build());
}
}
variables:
testStreamPools:
fn::invoke:
Function: oci:Streaming:getStreamPools
Arguments:
compartmentId: ${compartmentId}
id: ${streamPoolId}
name: ${streamPoolName}
state: ${streamPoolState}
Using getStreamPools
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 getStreamPools(args: GetStreamPoolsArgs, opts?: InvokeOptions): Promise<GetStreamPoolsResult>
function getStreamPoolsOutput(args: GetStreamPoolsOutputArgs, opts?: InvokeOptions): Output<GetStreamPoolsResult>
def get_stream_pools(compartment_id: Optional[str] = None,
filters: Optional[Sequence[_streaming.GetStreamPoolsFilter]] = None,
id: Optional[str] = None,
name: Optional[str] = None,
state: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetStreamPoolsResult
def get_stream_pools_output(compartment_id: Optional[pulumi.Input[str]] = None,
filters: Optional[pulumi.Input[Sequence[pulumi.Input[_streaming.GetStreamPoolsFilterArgs]]]] = None,
id: Optional[pulumi.Input[str]] = None,
name: Optional[pulumi.Input[str]] = None,
state: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetStreamPoolsResult]
func GetStreamPools(ctx *Context, args *GetStreamPoolsArgs, opts ...InvokeOption) (*GetStreamPoolsResult, error)
func GetStreamPoolsOutput(ctx *Context, args *GetStreamPoolsOutputArgs, opts ...InvokeOption) GetStreamPoolsResultOutput
> Note: This function is named GetStreamPools
in the Go SDK.
public static class GetStreamPools
{
public static Task<GetStreamPoolsResult> InvokeAsync(GetStreamPoolsArgs args, InvokeOptions? opts = null)
public static Output<GetStreamPoolsResult> Invoke(GetStreamPoolsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetStreamPoolsResult> getStreamPools(GetStreamPoolsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: oci:Streaming/getStreamPools:getStreamPools
arguments:
# arguments dictionary
The following arguments are supported:
- Compartment
Id string - The OCID of the compartment.
- Filters
List<Get
Stream Pools Filter> - Id string
- A filter to return only resources that match the given ID exactly.
- Name string
- A filter to return only resources that match the given name exactly.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- Compartment
Id string - The OCID of the compartment.
- Filters
[]Get
Stream Pools Filter - Id string
- A filter to return only resources that match the given ID exactly.
- Name string
- A filter to return only resources that match the given name exactly.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String - The OCID of the compartment.
- filters
List<Get
Stream Pools Filter> - id String
- A filter to return only resources that match the given ID exactly.
- name String
- A filter to return only resources that match the given name exactly.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id string - The OCID of the compartment.
- filters
Get
Stream Pools Filter[] - id string
- A filter to return only resources that match the given ID exactly.
- name string
- A filter to return only resources that match the given name exactly.
- state string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment_
id str - The OCID of the compartment.
- filters
Sequence[streaming.
Get Stream Pools Filter] - id str
- A filter to return only resources that match the given ID exactly.
- name str
- A filter to return only resources that match the given name exactly.
- state str
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- compartment
Id String - The OCID of the compartment.
- filters List<Property Map>
- id String
- A filter to return only resources that match the given ID exactly.
- name String
- A filter to return only resources that match the given name exactly.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
getStreamPools Result
The following output properties are available:
- Compartment
Id string - Compartment OCID that the pool belongs to.
- Stream
Pools List<GetStream Pools Stream Pool> - The list of stream_pools.
- Filters
List<Get
Stream Pools Filter> - Id string
- The OCID of the stream pool.
- Name string
- The name of the stream pool.
- State string
- The current state of the stream pool.
- Compartment
Id string - Compartment OCID that the pool belongs to.
- Stream
Pools []GetStream Pools Stream Pool - The list of stream_pools.
- Filters
[]Get
Stream Pools Filter - Id string
- The OCID of the stream pool.
- Name string
- The name of the stream pool.
- State string
- The current state of the stream pool.
- compartment
Id String - Compartment OCID that the pool belongs to.
- stream
Pools List<GetStream Pools Stream Pool> - The list of stream_pools.
- filters
List<Get
Stream Pools Filter> - id String
- The OCID of the stream pool.
- name String
- The name of the stream pool.
- state String
- The current state of the stream pool.
- compartment
Id string - Compartment OCID that the pool belongs to.
- stream
Pools GetStream Pools Stream Pool[] - The list of stream_pools.
- filters
Get
Stream Pools Filter[] - id string
- The OCID of the stream pool.
- name string
- The name of the stream pool.
- state string
- The current state of the stream pool.
- compartment_
id str - Compartment OCID that the pool belongs to.
- stream_
pools Sequence[streaming.Get Stream Pools Stream Pool] - The list of stream_pools.
- filters
Sequence[streaming.
Get Stream Pools Filter] - id str
- The OCID of the stream pool.
- name str
- The name of the stream pool.
- state str
- The current state of the stream pool.
- compartment
Id String - Compartment OCID that the pool belongs to.
- stream
Pools List<Property Map> - The list of stream_pools.
- filters List<Property Map>
- id String
- The OCID of the stream pool.
- name String
- The name of the stream pool.
- state String
- The current state of the stream pool.
Supporting Types
GetStreamPoolsFilter
GetStreamPoolsStreamPool
- Compartment
Id string - The OCID of the compartment.
- Custom
Encryption List<GetKeys Stream Pools 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
- A filter to return only resources that match the given ID exactly.
- 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 Pools Stream Pool Kafka Setting> - Settings for the Kafka compatibility layer.
- Lifecycle
State stringDetails - Any additional details about the current state of the stream.
- Name string
- A filter to return only resources that match the given name exactly.
- Private
Endpoint List<GetSettings Stream Pools Stream Pool Private Endpoint Setting> - Optional settings if the stream pool is private.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- 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 - The OCID of the compartment.
- Custom
Encryption []GetKeys Stream Pools 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
- A filter to return only resources that match the given ID exactly.
- 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 Pools Stream Pool Kafka Setting - Settings for the Kafka compatibility layer.
- Lifecycle
State stringDetails - Any additional details about the current state of the stream.
- Name string
- A filter to return only resources that match the given name exactly.
- Private
Endpoint []GetSettings Stream Pools Stream Pool Private Endpoint Setting - Optional settings if the stream pool is private.
- State string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- 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 - The OCID of the compartment.
- custom
Encryption List<GetKeys Stream Pools 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
- A filter to return only resources that match the given ID exactly.
- 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 Pools Stream Pool Kafka Setting> - Settings for the Kafka compatibility layer.
- lifecycle
State StringDetails - Any additional details about the current state of the stream.
- name String
- A filter to return only resources that match the given name exactly.
- private
Endpoint List<GetSettings Stream Pools Stream Pool Private Endpoint Setting> - Optional settings if the stream pool is private.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- 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 - The OCID of the compartment.
- custom
Encryption GetKeys Stream Pools 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
- A filter to return only resources that match the given ID exactly.
- 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 Pools Stream Pool Kafka Setting[] - Settings for the Kafka compatibility layer.
- lifecycle
State stringDetails - Any additional details about the current state of the stream.
- name string
- A filter to return only resources that match the given name exactly.
- private
Endpoint GetSettings Stream Pools Stream Pool Private Endpoint Setting[] - Optional settings if the stream pool is private.
- state string
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- 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 - The OCID of the compartment.
- custom_
encryption_ Sequence[streaming.keys Get Stream Pools 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
- A filter to return only resources that match the given ID exactly.
- 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 Pools 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
- A filter to return only resources that match the given name exactly.
- private_
endpoint_ Sequence[streaming.settings Get Stream Pools Stream Pool Private Endpoint Setting] - Optional settings if the stream pool is private.
- state str
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- 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 - The OCID of the compartment.
- 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
- A filter to return only resources that match the given ID exactly.
- 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
- A filter to return only resources that match the given name exactly.
- private
Endpoint List<Property Map>Settings - Optional settings if the stream pool is private.
- state String
- A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
- 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
GetStreamPoolsStreamPoolCustomEncryptionKey
- key_
state str - Life cycle State of the custom key
- kms_
key_ strid - Custom Encryption Key (Master Key) ocid.
GetStreamPoolsStreamPoolKafkaSetting
- 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.
GetStreamPoolsStreamPoolPrivateEndpointSetting
- 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.