oci.Streaming.StreamPool
Explore with Pulumi AI
This resource provides the Stream Pool resource in Oracle Cloud Infrastructure Streaming service.
Starts the provisioning of a new stream pool.
To track the progress of the provisioning, you can periodically call GetStreamPool.
In the response, the lifecycleState
parameter of the object tells you its current state.
Example Usage
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Oci = Pulumi.Oci;
return await Deployment.RunAsync(() =>
{
var testStreamPool = new Oci.Streaming.StreamPool("testStreamPool", new()
{
CompartmentId = @var.Compartment_id,
CustomEncryptionKey = new Oci.Streaming.Inputs.StreamPoolCustomEncryptionKeyArgs
{
KmsKeyId = oci_kms_key.Test_key.Id,
},
DefinedTags = @var.Stream_pool_defined_tags,
FreeformTags =
{
{ "Department", "Finance" },
},
KafkaSettings = new Oci.Streaming.Inputs.StreamPoolKafkaSettingsArgs
{
AutoCreateTopicsEnable = @var.Stream_pool_kafka_settings_auto_create_topics_enable,
BootstrapServers = @var.Stream_pool_kafka_settings_bootstrap_servers,
LogRetentionHours = @var.Stream_pool_kafka_settings_log_retention_hours,
NumPartitions = @var.Stream_pool_kafka_settings_num_partitions,
},
PrivateEndpointSettings = new Oci.Streaming.Inputs.StreamPoolPrivateEndpointSettingsArgs
{
NsgIds = @var.Stream_pool_private_endpoint_settings_nsg_ids,
PrivateEndpointIp = @var.Stream_pool_private_endpoint_settings_private_endpoint_ip,
SubnetId = oci_core_subnet.Test_subnet.Id,
},
});
});
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/Streaming"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := Streaming.NewStreamPool(ctx, "testStreamPool", &Streaming.StreamPoolArgs{
CompartmentId: pulumi.Any(_var.Compartment_id),
CustomEncryptionKey: &streaming.StreamPoolCustomEncryptionKeyArgs{
KmsKeyId: pulumi.Any(oci_kms_key.Test_key.Id),
},
DefinedTags: pulumi.Any(_var.Stream_pool_defined_tags),
FreeformTags: pulumi.AnyMap{
"Department": pulumi.Any("Finance"),
},
KafkaSettings: &streaming.StreamPoolKafkaSettingsArgs{
AutoCreateTopicsEnable: pulumi.Any(_var.Stream_pool_kafka_settings_auto_create_topics_enable),
BootstrapServers: pulumi.Any(_var.Stream_pool_kafka_settings_bootstrap_servers),
LogRetentionHours: pulumi.Any(_var.Stream_pool_kafka_settings_log_retention_hours),
NumPartitions: pulumi.Any(_var.Stream_pool_kafka_settings_num_partitions),
},
PrivateEndpointSettings: &streaming.StreamPoolPrivateEndpointSettingsArgs{
NsgIds: pulumi.Any(_var.Stream_pool_private_endpoint_settings_nsg_ids),
PrivateEndpointIp: pulumi.Any(_var.Stream_pool_private_endpoint_settings_private_endpoint_ip),
SubnetId: pulumi.Any(oci_core_subnet.Test_subnet.Id),
},
})
if err != nil {
return err
}
return nil
})
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.oci.Streaming.StreamPool;
import com.pulumi.oci.Streaming.StreamPoolArgs;
import com.pulumi.oci.Streaming.inputs.StreamPoolCustomEncryptionKeyArgs;
import com.pulumi.oci.Streaming.inputs.StreamPoolKafkaSettingsArgs;
import com.pulumi.oci.Streaming.inputs.StreamPoolPrivateEndpointSettingsArgs;
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) {
var testStreamPool = new StreamPool("testStreamPool", StreamPoolArgs.builder()
.compartmentId(var_.compartment_id())
.customEncryptionKey(StreamPoolCustomEncryptionKeyArgs.builder()
.kmsKeyId(oci_kms_key.test_key().id())
.build())
.definedTags(var_.stream_pool_defined_tags())
.freeformTags(Map.of("Department", "Finance"))
.kafkaSettings(StreamPoolKafkaSettingsArgs.builder()
.autoCreateTopicsEnable(var_.stream_pool_kafka_settings_auto_create_topics_enable())
.bootstrapServers(var_.stream_pool_kafka_settings_bootstrap_servers())
.logRetentionHours(var_.stream_pool_kafka_settings_log_retention_hours())
.numPartitions(var_.stream_pool_kafka_settings_num_partitions())
.build())
.privateEndpointSettings(StreamPoolPrivateEndpointSettingsArgs.builder()
.nsgIds(var_.stream_pool_private_endpoint_settings_nsg_ids())
.privateEndpointIp(var_.stream_pool_private_endpoint_settings_private_endpoint_ip())
.subnetId(oci_core_subnet.test_subnet().id())
.build())
.build());
}
}
import pulumi
import pulumi_oci as oci
test_stream_pool = oci.streaming.StreamPool("testStreamPool",
compartment_id=var["compartment_id"],
custom_encryption_key=oci.streaming.StreamPoolCustomEncryptionKeyArgs(
kms_key_id=oci_kms_key["test_key"]["id"],
),
defined_tags=var["stream_pool_defined_tags"],
freeform_tags={
"Department": "Finance",
},
kafka_settings=oci.streaming.StreamPoolKafkaSettingsArgs(
auto_create_topics_enable=var["stream_pool_kafka_settings_auto_create_topics_enable"],
bootstrap_servers=var["stream_pool_kafka_settings_bootstrap_servers"],
log_retention_hours=var["stream_pool_kafka_settings_log_retention_hours"],
num_partitions=var["stream_pool_kafka_settings_num_partitions"],
),
private_endpoint_settings=oci.streaming.StreamPoolPrivateEndpointSettingsArgs(
nsg_ids=var["stream_pool_private_endpoint_settings_nsg_ids"],
private_endpoint_ip=var["stream_pool_private_endpoint_settings_private_endpoint_ip"],
subnet_id=oci_core_subnet["test_subnet"]["id"],
))
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testStreamPool = new oci.streaming.StreamPool("testStreamPool", {
compartmentId: _var.compartment_id,
customEncryptionKey: {
kmsKeyId: oci_kms_key.test_key.id,
},
definedTags: _var.stream_pool_defined_tags,
freeformTags: {
Department: "Finance",
},
kafkaSettings: {
autoCreateTopicsEnable: _var.stream_pool_kafka_settings_auto_create_topics_enable,
bootstrapServers: _var.stream_pool_kafka_settings_bootstrap_servers,
logRetentionHours: _var.stream_pool_kafka_settings_log_retention_hours,
numPartitions: _var.stream_pool_kafka_settings_num_partitions,
},
privateEndpointSettings: {
nsgIds: _var.stream_pool_private_endpoint_settings_nsg_ids,
privateEndpointIp: _var.stream_pool_private_endpoint_settings_private_endpoint_ip,
subnetId: oci_core_subnet.test_subnet.id,
},
});
resources:
testStreamPool:
type: oci:Streaming:StreamPool
properties:
#Required
compartmentId: ${var.compartment_id}
customEncryptionKey:
kmsKeyId: ${oci_kms_key.test_key.id}
definedTags: ${var.stream_pool_defined_tags}
freeformTags:
Department: Finance
kafkaSettings:
autoCreateTopicsEnable: ${var.stream_pool_kafka_settings_auto_create_topics_enable}
bootstrapServers: ${var.stream_pool_kafka_settings_bootstrap_servers}
logRetentionHours: ${var.stream_pool_kafka_settings_log_retention_hours}
numPartitions: ${var.stream_pool_kafka_settings_num_partitions}
privateEndpointSettings:
nsgIds: ${var.stream_pool_private_endpoint_settings_nsg_ids}
privateEndpointIp: ${var.stream_pool_private_endpoint_settings_private_endpoint_ip}
subnetId: ${oci_core_subnet.test_subnet.id}
Create StreamPool Resource
new StreamPool(name: string, args: StreamPoolArgs, opts?: CustomResourceOptions);
@overload
def StreamPool(resource_name: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
custom_encryption_key: Optional[_streaming.StreamPoolCustomEncryptionKeyArgs] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
kafka_settings: Optional[_streaming.StreamPoolKafkaSettingsArgs] = None,
name: Optional[str] = None,
private_endpoint_settings: Optional[_streaming.StreamPoolPrivateEndpointSettingsArgs] = None)
@overload
def StreamPool(resource_name: str,
args: StreamPoolArgs,
opts: Optional[ResourceOptions] = None)
func NewStreamPool(ctx *Context, name string, args StreamPoolArgs, opts ...ResourceOption) (*StreamPool, error)
public StreamPool(string name, StreamPoolArgs args, CustomResourceOptions? opts = null)
public StreamPool(String name, StreamPoolArgs args)
public StreamPool(String name, StreamPoolArgs args, CustomResourceOptions options)
type: oci:Streaming:StreamPool
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StreamPoolArgs
- 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 StreamPoolArgs
- 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 StreamPoolArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StreamPoolArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StreamPoolArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
StreamPool Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
The StreamPool resource accepts the following input properties:
- Compartment
Id string (Updatable) The OCID of the compartment that contains the stream.
- Custom
Encryption StreamKey Pool Custom Encryption Key (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- Dictionary<string, object>
(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"}
- Dictionary<string, object>
(Updatable) 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"}
- Kafka
Settings StreamPool Kafka Settings (Updatable) Settings for the Kafka compatibility layer.
- Name string
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- Private
Endpoint StreamSettings Pool Private Endpoint Settings Optional parameters if a private stream pool is requested.
- Compartment
Id string (Updatable) The OCID of the compartment that contains the stream.
- Custom
Encryption StreamKey Pool Custom Encryption Key Args (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- map[string]interface{}
(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"}
- map[string]interface{}
(Updatable) 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"}
- Kafka
Settings StreamPool Kafka Settings Args (Updatable) Settings for the Kafka compatibility layer.
- Name string
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- Private
Endpoint StreamSettings Pool Private Endpoint Settings Args Optional parameters if a private stream pool is requested.
- compartment
Id String (Updatable) The OCID of the compartment that contains the stream.
- custom
Encryption StreamKey Pool Custom Encryption Key (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- Map<String,Object>
(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"}
- Map<String,Object>
(Updatable) 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"}
- kafka
Settings StreamPool Kafka Settings (Updatable) Settings for the Kafka compatibility layer.
- name String
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- private
Endpoint StreamSettings Pool Private Endpoint Settings Optional parameters if a private stream pool is requested.
- compartment
Id string (Updatable) The OCID of the compartment that contains the stream.
- custom
Encryption StreamKey Pool Custom Encryption Key (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- {[key: string]: any}
(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"}
- {[key: string]: any}
(Updatable) 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"}
- kafka
Settings StreamPool Kafka Settings (Updatable) Settings for the Kafka compatibility layer.
- name string
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- private
Endpoint StreamSettings Pool Private Endpoint Settings Optional parameters if a private stream pool is requested.
- compartment_
id str (Updatable) The OCID of the compartment that contains the stream.
- custom_
encryption_ Streamkey Pool Custom Encryption Key Args (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- Mapping[str, Any]
(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"}
- Mapping[str, Any]
(Updatable) 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"}
- kafka_
settings StreamPool Kafka Settings Args (Updatable) Settings for the Kafka compatibility layer.
- name str
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- private_
endpoint_ Streamsettings Pool Private Endpoint Settings Args Optional parameters if a private stream pool is requested.
- compartment
Id String (Updatable) The OCID of the compartment that contains the stream.
- custom
Encryption Property MapKey (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- Map<Any>
(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"}
- Map<Any>
(Updatable) 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"}
- kafka
Settings Property Map (Updatable) Settings for the Kafka compatibility layer.
- name String
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- private
Endpoint Property MapSettings Optional parameters if a private stream pool is requested.
Outputs
All input properties are implicitly available as output properties. Additionally, the StreamPool resource produces the following output properties:
- 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.
- Id string
The provider-assigned unique ID for this managed resource.
- 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.
- Lifecycle
State stringDetails Any additional details about the current state of the stream.
- State string
The current state of the stream pool.
- 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
- 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.
- Id string
The provider-assigned unique ID for this managed resource.
- 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.
- Lifecycle
State stringDetails Any additional details about the current state of the stream.
- State string
The current state of the stream pool.
- 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
- 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.
- id String
The provider-assigned unique ID for this managed resource.
- 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.
- lifecycle
State StringDetails Any additional details about the current state of the stream.
- state String
The current state of the stream pool.
- 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
- 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.
- id string
The provider-assigned unique ID for this managed resource.
- 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.
- lifecycle
State stringDetails Any additional details about the current state of the stream.
- state string
The current state of the stream pool.
- 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
- 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.
- id str
The provider-assigned unique ID for this managed resource.
- 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.
- lifecycle_
state_ strdetails Any additional details about the current state of the stream.
- state str
The current state of the stream pool.
- 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
- 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.
- id String
The provider-assigned unique ID for this managed resource.
- 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.
- lifecycle
State StringDetails Any additional details about the current state of the stream.
- state String
The current state of the stream pool.
- 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
Look up Existing StreamPool Resource
Get an existing StreamPool 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?: StreamPoolState, opts?: CustomResourceOptions): StreamPool
@staticmethod
def get(resource_name: str,
id: str,
opts: Optional[ResourceOptions] = None,
compartment_id: Optional[str] = None,
custom_encryption_key: Optional[_streaming.StreamPoolCustomEncryptionKeyArgs] = None,
defined_tags: Optional[Mapping[str, Any]] = None,
endpoint_fqdn: Optional[str] = None,
freeform_tags: Optional[Mapping[str, Any]] = None,
is_private: Optional[bool] = None,
kafka_settings: Optional[_streaming.StreamPoolKafkaSettingsArgs] = None,
lifecycle_state_details: Optional[str] = None,
name: Optional[str] = None,
private_endpoint_settings: Optional[_streaming.StreamPoolPrivateEndpointSettingsArgs] = None,
state: Optional[str] = None,
time_created: Optional[str] = None) -> StreamPool
func GetStreamPool(ctx *Context, name string, id IDInput, state *StreamPoolState, opts ...ResourceOption) (*StreamPool, error)
public static StreamPool Get(string name, Input<string> id, StreamPoolState? state, CustomResourceOptions? opts = null)
public static StreamPool get(String name, Output<String> id, StreamPoolState 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.
- Compartment
Id string (Updatable) The OCID of the compartment that contains the stream.
- Custom
Encryption StreamKey Pool Custom Encryption Key (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- Dictionary<string, object>
(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"}
- 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, object>
(Updatable) 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"}
- 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 StreamPool Kafka Settings (Updatable) Settings for the Kafka compatibility layer.
- Lifecycle
State stringDetails Any additional details about the current state of the stream.
- Name string
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- Private
Endpoint StreamSettings Pool Private Endpoint Settings Optional parameters if a private stream pool is requested.
- State string
The current state of the stream pool.
- 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 (Updatable) The OCID of the compartment that contains the stream.
- Custom
Encryption StreamKey Pool Custom Encryption Key Args (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- map[string]interface{}
(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"}
- 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]interface{}
(Updatable) 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"}
- 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 StreamPool Kafka Settings Args (Updatable) Settings for the Kafka compatibility layer.
- Lifecycle
State stringDetails Any additional details about the current state of the stream.
- Name string
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- Private
Endpoint StreamSettings Pool Private Endpoint Settings Args Optional parameters if a private stream pool is requested.
- State string
The current state of the stream pool.
- 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 (Updatable) The OCID of the compartment that contains the stream.
- custom
Encryption StreamKey Pool Custom Encryption Key (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- Map<String,Object>
(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"}
- 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,Object>
(Updatable) 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"}
- 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 StreamPool Kafka Settings (Updatable) Settings for the Kafka compatibility layer.
- lifecycle
State StringDetails Any additional details about the current state of the stream.
- name String
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- private
Endpoint StreamSettings Pool Private Endpoint Settings Optional parameters if a private stream pool is requested.
- state String
The current state of the stream pool.
- 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 (Updatable) The OCID of the compartment that contains the stream.
- custom
Encryption StreamKey Pool Custom Encryption Key (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- {[key: string]: any}
(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"}
- 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]: any}
(Updatable) 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"}
- 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 StreamPool Kafka Settings (Updatable) Settings for the Kafka compatibility layer.
- lifecycle
State stringDetails Any additional details about the current state of the stream.
- name string
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- private
Endpoint StreamSettings Pool Private Endpoint Settings Optional parameters if a private stream pool is requested.
- state string
The current state of the stream pool.
- 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 (Updatable) The OCID of the compartment that contains the stream.
- custom_
encryption_ Streamkey Pool Custom Encryption Key Args (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- Mapping[str, Any]
(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"}
- 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, Any]
(Updatable) 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"}
- 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 StreamPool Kafka Settings Args (Updatable) Settings for the Kafka compatibility layer.
- lifecycle_
state_ strdetails Any additional details about the current state of the stream.
- name str
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- private_
endpoint_ Streamsettings Pool Private Endpoint Settings Args Optional parameters if a private stream pool is requested.
- state str
The current state of the stream pool.
- 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 (Updatable) The OCID of the compartment that contains the stream.
- custom
Encryption Property MapKey (Updatable) The OCID of the custom encryption key to be used or deleted if currently being used.
- Map<Any>
(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"}
- 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<Any>
(Updatable) 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"}
- 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 Property Map (Updatable) Settings for the Kafka compatibility layer.
- lifecycle
State StringDetails Any additional details about the current state of the stream.
- name String
(Updatable) The name of the stream pool. Avoid entering confidential information. Example:
MyStreamPool
- private
Endpoint Property MapSettings Optional parameters if a private stream pool is requested.
- state String
The current state of the stream pool.
- 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
StreamPoolCustomEncryptionKey, StreamPoolCustomEncryptionKeyArgs
- kms_
key_ strid (Updatable) Custom Encryption Key (Master Key) ocid.
- key_
state str Life cycle State of the custom key
StreamPoolKafkaSettings, StreamPoolKafkaSettingsArgs
- Auto
Create boolTopics Enable (Updatable) Enable auto creation of topic on the server.
- Bootstrap
Servers string (Updatable) Bootstrap servers.
- Log
Retention intHours (Updatable) The number of hours to keep a log file before deleting it (in hours).
- Num
Partitions int (Updatable) The default number of log partitions per topic.
- Auto
Create boolTopics Enable (Updatable) Enable auto creation of topic on the server.
- Bootstrap
Servers string (Updatable) Bootstrap servers.
- Log
Retention intHours (Updatable) The number of hours to keep a log file before deleting it (in hours).
- Num
Partitions int (Updatable) The default number of log partitions per topic.
- auto
Create BooleanTopics Enable (Updatable) Enable auto creation of topic on the server.
- bootstrap
Servers String (Updatable) Bootstrap servers.
- log
Retention IntegerHours (Updatable) The number of hours to keep a log file before deleting it (in hours).
- num
Partitions Integer (Updatable) The default number of log partitions per topic.
- auto
Create booleanTopics Enable (Updatable) Enable auto creation of topic on the server.
- bootstrap
Servers string (Updatable) Bootstrap servers.
- log
Retention numberHours (Updatable) The number of hours to keep a log file before deleting it (in hours).
- num
Partitions number (Updatable) The default number of log partitions per topic.
- auto_
create_ booltopics_ enable (Updatable) Enable auto creation of topic on the server.
- bootstrap_
servers str (Updatable) Bootstrap servers.
- log_
retention_ inthours (Updatable) The number of hours to keep a log file before deleting it (in hours).
- num_
partitions int (Updatable) The default number of log partitions per topic.
- auto
Create BooleanTopics Enable (Updatable) Enable auto creation of topic on the server.
- bootstrap
Servers String (Updatable) Bootstrap servers.
- log
Retention NumberHours (Updatable) The number of hours to keep a log file before deleting it (in hours).
- num
Partitions Number (Updatable) The default number of log partitions per topic.
StreamPoolPrivateEndpointSettings, StreamPoolPrivateEndpointSettingsArgs
- Nsg
Ids List<string> The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
- Private
Endpoint stringIp The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
- Subnet
Id string If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.
** 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
- Nsg
Ids []string The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
- Private
Endpoint stringIp The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
- Subnet
Id string If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.
** 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
- nsg
Ids List<String> The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
- private
Endpoint StringIp The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
- subnet
Id String If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.
** 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
- nsg
Ids string[] The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
- private
Endpoint stringIp The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
- subnet
Id string If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.
** 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
- nsg_
ids Sequence[str] The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
- private_
endpoint_ strip The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
- subnet_
id str If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.
** 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
- nsg
Ids List<String> The optional list of network security groups to be used with the private endpoint of the stream pool. That value cannot be changed.
- private
Endpoint StringIp The optional private IP you want to be associated with your private stream pool. That parameter can only be specified when the subnetId parameter is set. It cannot be changed. The private IP needs to be part of the CIDR range of the specified subnetId or the creation will fail. If not specified a random IP inside the subnet will be chosen. After the stream pool is created, a custom FQDN, pointing to this private IP, is created. The FQDN is then used to access the service instead of the private IP.
- subnet
Id String If specified, the stream pool will be private and only accessible from inside that subnet. Producing-to and consuming-from a stream inside a private stream pool can also only be done from inside the subnet. That value cannot be changed.
** 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
Import
StreamPools can be imported using the id
, e.g.
$ pulumi import oci:Streaming/streamPool:StreamPool test_stream_pool "id"
Package Details
- Repository
- oci pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.