oracle.oci.oci_streaming_stream_pool – Manage a StreamPool resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.11.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_streaming_stream_pool.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a StreamPool resource in Oracle Cloud Infrastructure

  • For state=present, 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.

  • This resource has the following action operations in the oracle.oci.oci_streaming_stream_pool_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment that contains the stream.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
custom_encryption_key_details
dictionary
This parameter is updatable.
kms_key_id
string / required
Custom Encryption Key (Master Key) ocid.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
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"}`
This parameter is updatable.
kafka_settings
dictionary
This parameter is updatable.
auto_create_topics_enable
boolean
    Choices:
  • no
  • yes
Enable auto creation of topic on the server.
bootstrap_servers
string
Bootstrap servers.
log_retention_hours
integer
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.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
name
string
The name of the stream pool. Avoid entering confidential information.
Example: `MyStreamPool`
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.
private_endpoint_details
dictionary
nsg_ids
list / elements=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_ip
string
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.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the StreamPool.
Use state=present to create or update a StreamPool.
Use state=absent to delete a StreamPool.
stream_pool_id
string
The OCID of the stream pool.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create stream_pool
  oci_streaming_stream_pool:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    private_endpoint_details:
      # optional
      subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"
      private_endpoint_ip: private_endpoint_ip_example
      nsg_ids: [ "nsg_ids_example" ]
    kafka_settings:
      # optional
      bootstrap_servers: bootstrap_servers_example
      auto_create_topics_enable: true
      log_retention_hours: 56
      num_partitions: 56
    custom_encryption_key_details:
      # required
      kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update stream_pool
  oci_streaming_stream_pool:
    # required
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    name: name_example
    kafka_settings:
      # optional
      bootstrap_servers: bootstrap_servers_example
      auto_create_topics_enable: true
      log_retention_hours: 56
      num_partitions: 56
    custom_encryption_key_details:
      # required
      kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update stream_pool using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_streaming_stream_pool:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example

    # optional
    kafka_settings:
      # optional
      bootstrap_servers: bootstrap_servers_example
      auto_create_topics_enable: true
      log_retention_hours: 56
      num_partitions: 56
    custom_encryption_key_details:
      # required
      kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete stream_pool
  oci_streaming_stream_pool:
    # required
    stream_pool_id: "ocid1.streampool.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete stream_pool using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_streaming_stream_pool:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    name: name_example
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
stream_pool
complex
on success
Details of the StreamPool resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'custom_encryption_key': {'key_state': 'ACTIVE', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx'}, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'endpoint_fqdn': 'endpoint_fqdn_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_private': True, 'kafka_settings': {'auto_create_topics_enable': True, 'bootstrap_servers': 'bootstrap_servers_example', 'log_retention_hours': 56, 'num_partitions': 56}, 'lifecycle_state': 'CREATING', 'lifecycle_state_details': 'lifecycle_state_details_example', 'name': 'name_example', 'private_endpoint_settings': {'nsg_ids': [], 'private_endpoint_ip': 'private_endpoint_ip_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}, 'time_created': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
Compartment OCID that the pool belongs to.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
custom_encryption_key
complex
on success

   
key_state
string
on success
Life cycle State of the custom key

Sample:
ACTIVE
   
kms_key_id
string
on success
Custom Encryption Key (Master Key) ocid.

Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}'

Sample:
{'Operations': {'CostCenter': 'US'}}
 
endpoint_fqdn
string
on success
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.

Sample:
endpoint_fqdn_example
 
freeform_tags
dictionary
on success
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.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the stream pool.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
is_private
boolean
on success
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.

Sample:
True
 
kafka_settings
complex
on success

   
auto_create_topics_enable
boolean
on success
Enable auto creation of topic on the server.

Sample:
True
   
bootstrap_servers
string
on success
Bootstrap servers.

Sample:
bootstrap_servers_example
   
log_retention_hours
integer
on success
The number of hours to keep a log file before deleting it (in hours).

Sample:
56
   
num_partitions
integer
on success
The default number of log partitions per topic.

Sample:
56
 
lifecycle_state
string
on success
The current state of the stream pool.

Sample:
CREATING
 
lifecycle_state_details
string
on success
Any additional details about the current state of the stream.

Sample:
lifecycle_state_details_example
 
name
string
on success
The name of the stream pool.

Sample:
name_example
 
private_endpoint_settings
complex
on success

   
nsg_ids
list / elements=string
on success
The optional list of network security groups that are associated with the private endpoint of the stream pool.

   
private_endpoint_ip
string
on success
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.

Sample:
private_endpoint_ip_example
   
subnet_id
string
on success
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.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
time_created
string
on success
The date and time the stream pool was created, expressed in in RFC 3339 timestamp format.
Example: `2018-04-20T00:00:07.405Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)