stream_pools

Creates, updates, deletes, gets or lists a stream_pools resource.

Overview

Name	`stream_pools`
Type	Resource
Id	`oci.streaming.stream_pools`

Fields

The following fields are returned by SELECT queries:

get
list

Name	Datatype	Description
`id`	`string`	The OCID of the stream pool. (example: ocid1.streampool.realm.region.mnopqr789)
`name`	`string`	The name of the stream pool. (example: MyStreamPool)
`compartmentId`	`string`	Compartment OCID that the pool belongs to. (example: ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa)
`customEncryptionKey`	`object`	Custom Encryption Key which will be used for encryption by all the streams in the pool.
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}'
`endpointFqdn`	`string`	The FQDN used to access the streams inside the stream pool (same FQDN as the messagesEndpoint attribute of a [Stream](#/en/streaming/20180418/Stream) object). If the stream pool is private, the FQDN is customized and can only be accessed from inside the associated subnetId, otherwise the FQDN is publicly resolvable. Depending on which protocol you attempt to use, you need to either prepend https or append the Kafka port.
`freeformTags`	`object`	Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. Exists for cross-compatibility only. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`isPrivate`	`boolean`	True if the stream pool is private, false otherwise. If the stream pool is private, the streams inside the stream pool can only be accessed from inside the associated subnetId.
`kafkaSettings`	`object`	Settings for the Kafka compatibility layer.
`lifecycleState`	`string`	The current state of the stream pool. (CREATING, ACTIVE, DELETING, DELETED, FAILED, UPDATING)
`lifecycleStateDetails`	`string`	Any additional details about the current state of the stream.
`privateEndpointSettings`	`object`	Optional settings if the stream pool is private.
`securityAttributes`	`object`	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
`timeCreated`	`string (date-time)`	The date and time the stream pool was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z`

The summary representation of a stream pool.

Name	Datatype	Description
`id`	`string`	The OCID of the stream pool. (example: ocid1.streampool.realm.region.mnopqr789)
`name`	`string`	The name of the stream pool. (example: MyStreamPool)
`compartmentId`	`string`	Compartment OCID that the pool belongs to. (example: ocid1.compartment.oc1..aaaaaaaa2byuam5ewxzrcs2iqzh7okx84jae6j4uhkih5wdbrkkwuxv3qgpa)
`definedTags`	`object`	Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm). Example: `{"Operations": {"CostCenter": "42"}}`
`freeformTags`	`object`	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](/Content/General/Concepts/resourcetags.htm). Example: `{"Department": "Finance"}`
`isPrivate`	`boolean`	True if the stream pool is private, false otherwise. The associated endpoint and subnetId of a private stream pool can be retrieved through the [GetStreamPool](#/en/streaming/20180418/StreamPool/GetStreamPool) API.
`lifecycleState`	`string`	The current state of the stream pool. (CREATING, ACTIVE, DELETING, DELETED, FAILED, UPDATING)
`securityAttributes`	`object`	Security attributes for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm). Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
`timeCreated`	`string (date-time)`	The date and time the stream pool was created, expressed in in [RFC 3339](https://tools.ietf.org/rfc/rfc3339) timestamp format. Example: `2018-04-20T00:00:07.405Z`

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
`get`	`select`	`streamPoolId`, `region`	`opc-request-id`	Gets detailed information about the stream pool, such as Kafka settings.
`list`	`select`	`compartmentId`, `region`	`id`, `name`, `limit`, `page`, `sortBy`, `sortOrder`, `lifecycleState`, `opc-request-id`	List the stream pools for a given compartment ID.
`create`	`insert`	`region`, `name`, `compartmentId`	`opc-request-id`, `opc-retry-token`	Starts the provisioning of a new stream pool.<br />To track the progress of the provisioning, you can periodically call GetStreamPool.<br />In the response, the `lifecycleState` parameter of the object tells you its current state.<br />
`update`	`update`	`streamPoolId`, `region`	`opc-request-id`, `if-match`	Updates the specified stream pool.<br />
`delete`	`delete`	`streamPoolId`, `region`	`opc-request-id`, `if-match`	Deletes a stream pool. All containing streams will also be deleted.<br />The default stream pool of a compartment cannot be deleted.<br />
`change_compartment`	`exec`	`streamPoolId`, `region`, `compartmentId`	`if-match`, `opc-request-id`	Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
`compartmentId`	`string`	The OCID of the compartment.
`region`	`string`	OCI region identifier (e.g. us-ashburn-1, ap-sydney-1); resolves from OCI_REGION when not supplied in the query. (default: us-ashburn-1, x-stackQL-envVar: OCI_REGION)
`streamPoolId`	`string`	The OCID of the stream pool.
`id`	`string`	A filter to return only resources that match the given ID exactly.
`if-match`	`string`	For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value.
`lifecycleState`	`string`	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive.
`limit`	`integer`	The maximum number of items to return. The value must be between 1 and 50. The default is 10.
`name`	`string`	A filter to return only resources that match the given name exactly.
`opc-request-id`	`string`	The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.
`opc-retry-token`	`string`	A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
`page`	`string`	The page at which to start retrieving results.
`sortBy`	`string`	The field to sort by. You can provide no more than one sort order. By default, `TIMECREATED` sorts results in descending order and `NAME` sorts results in ascending order.
`sortOrder`	`string`	The sort order to use, either 'asc' or 'desc'.

`SELECT` examples

get
list

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

SELECT
id,
name,
compartmentId,
customEncryptionKey,
definedTags,
endpointFqdn,
freeformTags,
isPrivate,
kafkaSettings,
lifecycleState,
lifecycleStateDetails,
privateEndpointSettings,
securityAttributes,
timeCreated
FROM oci.streaming.stream_pools
WHERE streamPoolId = '{{ streamPoolId }}' -- required
AND region = '{{ region }}' -- required
AND opc-request-id = '{{ opc-request-id }}'
;

List the stream pools for a given compartment ID.

SELECT
id,
name,
compartmentId,
definedTags,
freeformTags,
isPrivate,
lifecycleState,
securityAttributes,
timeCreated
FROM oci.streaming.stream_pools
WHERE compartmentId = '{{ compartmentId }}' -- required
AND region = '{{ region }}' -- required
AND id = '{{ id }}'
AND name = '{{ name }}'
AND limit = '{{ limit }}'
AND page = '{{ page }}'
AND sortBy = '{{ sortBy }}'
AND sortOrder = '{{ sortOrder }}'
AND lifecycleState = '{{ lifecycleState }}'
AND opc-request-id = '{{ opc-request-id }}'
;

`INSERT` examples

create
Manifest

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.

INSERT INTO oci.streaming.stream_pools (
compartmentId,
customEncryptionKeyDetails,
definedTags,
freeformTags,
kafkaSettings,
name,
privateEndpointDetails,
securityAttributes,
region,
opc-request-id,
opc-retry-token
)
SELECT 
'{{ compartmentId }}' /* required */,
'{{ customEncryptionKeyDetails }}',
'{{ definedTags }}',
'{{ freeformTags }}',
'{{ kafkaSettings }}',
'{{ name }}' /* required */,
'{{ privateEndpointDetails }}',
'{{ securityAttributes }}',
'{{ region }}',
'{{ opc-request-id }}',
'{{ opc-retry-token }}'
RETURNING
id,
name,
compartmentId,
customEncryptionKey,
definedTags,
endpointFqdn,
freeformTags,
isPrivate,
kafkaSettings,
lifecycleState,
lifecycleStateDetails,
privateEndpointSettings,
securityAttributes,
timeCreated
;

# Description fields are for documentation purposes
- name: stream_pools
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the stream_pools resource.
  - name: compartmentId
    value: "{{ compartmentId }}"
    description: |
      The OCID of the compartment that contains the stream.
  - name: customEncryptionKeyDetails
    description: |
      The OCID of the custom encryption key to be used or deleted if currently being used.
    value:
      kmsKeyId: "{{ kmsKeyId }}"
  - name: definedTags
    value: "{{ definedTags }}"
    description: |
      Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Operations": {"CostCenter": "42"}}`
  - name: freeformTags
    value: "{{ freeformTags }}"
    description: |
      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](/Content/General/Concepts/resourcetags.htm).
      Example: `{"Department": "Finance"}`
  - name: kafkaSettings
    description: |
      Settings for the Kafka compatibility layer.
    value:
      autoCreateTopicsEnable: {{ autoCreateTopicsEnable }}
      bootstrapServers: "{{ bootstrapServers }}"
      logRetentionHours: {{ logRetentionHours }}
      numPartitions: {{ numPartitions }}
  - name: name
    value: "{{ name }}"
    description: |
      The name of the stream pool. Avoid entering confidential information.
      Example: `MyStreamPool`
  - name: privateEndpointDetails
    description: |
      Optional parameters if a private stream pool is requested.
    value:
      nsgIds:
        - "{{ nsgIds }}"
      privateEndpointIp: "{{ privateEndpointIp }}"
      subnetId: "{{ subnetId }}"
  - name: securityAttributes
    value: "{{ securityAttributes }}"
    description: |
      Security attributes for this resource. Each key is predefined and scoped to a namespace.
      For more information, see [Resource Tags](/iaas/Content/General/Concepts/resourcetags.htm).
      Example: `{"Oracle-ZPR": {"MaxEgressCount": {"value": "42", "mode": "enforce"}}}`
  - name: opc-request-id
    value: "{{ opc-request-id }}"
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
    description: The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID. 
  - name: opc-retry-token
    value: "{{ opc-retry-token }}"
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).
    description: A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations (for example, if a resource has been deleted and purged from the system, then a retry of the original creation request may be rejected).

`UPDATE` examples

update

Updates the specified stream pool.

UPDATE oci.streaming.stream_pools
SET 
customEncryptionKeyDetails = '{{ customEncryptionKeyDetails }}',
definedTags = '{{ definedTags }}',
freeformTags = '{{ freeformTags }}',
kafkaSettings = '{{ kafkaSettings }}',
name = '{{ name }}',
securityAttributes = '{{ securityAttributes }}'
WHERE 
streamPoolId = '{{ streamPoolId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id}}'
AND if-match = '{{ if-match}}'
RETURNING
id,
name,
compartmentId,
customEncryptionKey,
definedTags,
endpointFqdn,
freeformTags,
isPrivate,
kafkaSettings,
lifecycleState,
lifecycleStateDetails,
privateEndpointSettings,
securityAttributes,
timeCreated;

`DELETE` examples

delete

Deletes a stream pool. All containing streams will also be deleted. The default stream pool of a compartment cannot be deleted.

DELETE FROM oci.streaming.stream_pools
WHERE streamPoolId = '{{ streamPoolId }}' --required
AND region = '{{ region }}' --required
AND opc-request-id = '{{ opc-request-id }}'
AND if-match = '{{ if-match }}'
;

Lifecycle Methods

change_compartment

Moves a resource into a different compartment. When provided, If-Match is checked against ETag values of the resource.

EXEC oci.streaming.stream_pools.change_compartment 
@streamPoolId='{{ streamPoolId }}' --required, 
@region='{{ region }}' --required, 
@if-match='{{ if-match }}', 
@opc-request-id='{{ opc-request-id }}' 
@@json=
'{
"compartmentId": "{{ compartmentId }}"
}'
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​

Lifecycle Methods​