Creates a group-cursor.

The top level –endpoint parameter must be supplied for this operation.


oci streaming stream cursor create-group-cursor [OPTIONS]

Required Parameters

--group-name [text]

Name of the consumer group.

--stream-id [text]

The OCID of the stream.

--type [text]

The type of the cursor. This value is only used when the group is created.

Accepted values are:


Optional Parameters

--commit-on-get [boolean]

When using consumer-groups, the default commit-on-get behaviour can be overriden by setting this value to false. If disabled, a consumer must manually commit their cursors.

--from-json [text]

Provide input to this command as a JSON document from a file using the file://path-to/file syntax.

The --generate-full-command-json-input option can be used to generate a sample json file to be used with this command option. The key names are pre-populated and match the command option names (converted to camelCase format, e.g. compartment-id –> compartmentId), while the values of the keys need to be populated by the user before using the sample file as an input to this command. For any command option that accepts multiple values, the value of the key can be a JSON array.

Options can still be provided on the command line. If an option exists in both the JSON document and the command line then the command line specified value will be used.

For examples on usage of this option, please see our “using CLI with advanced JSON options” link:

--instance-name [text]

A unique identifier for the instance joining the consumer group. If an instanceName is not provided, a UUID will be generated and used.

--time [datetime]

The time to consume from if type is AT_TIME.

The following datetime formats are supported:

Format: YYYY-MM-DDTHH:mm:ss.sssTZD
Example: 2017-09-15T20:30:00.123Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T20:30:00Z
Example: 2017-09-15T20:30Z
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00.456-08:00, 2017-09-15T12:30:00.456-0800
Format: YYYY-MM-DDTHH:mm:ssTZD
Example: 2017-09-15T12:30:00-08:00, 2017-09-15T12:30:00-0800
Example: 2017-09-15T12:30-08:00, 2017-09-15T12:30-0800

The timezone for this date and time will be taken as UTC (Needs to be surrounded by single or double quotes)

Format: 'YYYY-MM-DD HH:mm' or "YYYY-MM-DD HH:mm"
Example: '2017-09-15 17:25'

This date will be taken as midnight UTC of that day

Format: YYYY-MM-DD
Example: 2017-09-15
Example: 1412195400
--timeout-in-ms [integer]

The amount of a consumer instance inactivity time, before partition reservations are released.


Copy the following CLI commands into a file named Run the command by typing “bash” and replacing the example parameters with your own.

Please note this sample will only work in the POSIX-compliant bash-like shell. You need to set up the OCI configuration and appropriate security policies before trying the examples.

    export name=<substitute-value-of-name> #
    export partitions=<substitute-value-of-partitions> #
    export group_name=<substitute-value-of-group_name> #
    export type=<substitute-value-of-type> #

    stream_id=$(oci streaming admin stream create --name $name --partitions $partitions --query --raw-output)

    oci streaming stream cursor create-group-cursor --group-name $group_name --stream-id $stream_id --type $type