CreateOpensearchClusterPipelineDetails

class oci.opensearch.models.CreateOpensearchClusterPipelineDetails(**kwargs)

Bases: object

The configuration details for a new OpenSearch cluster pipeline.

Methods:

__init__(**kwargs)

Initializes a new CreateOpensearchClusterPipelineDetails object with values from keyword arguments.

Attributes:

compartment_id

[Required] Gets the compartment_id of this CreateOpensearchClusterPipelineDetails.

data_prepper_configuration_body

[Required] Gets the data_prepper_configuration_body of this CreateOpensearchClusterPipelineDetails.

defined_tags

Gets the defined_tags of this CreateOpensearchClusterPipelineDetails.

display_name

[Required] Gets the display_name of this CreateOpensearchClusterPipelineDetails.

freeform_tags

Gets the freeform_tags of this CreateOpensearchClusterPipelineDetails.

memory_gb

[Required] Gets the memory_gb of this CreateOpensearchClusterPipelineDetails.

node_count

[Required] Gets the node_count of this CreateOpensearchClusterPipelineDetails.

node_shape

Gets the node_shape of this CreateOpensearchClusterPipelineDetails.

nsg_id

Gets the nsg_id of this CreateOpensearchClusterPipelineDetails.

ocpu_count

[Required] Gets the ocpu_count of this CreateOpensearchClusterPipelineDetails.

pipeline_configuration_body

[Required] Gets the pipeline_configuration_body of this CreateOpensearchClusterPipelineDetails.

reverse_connection_endpoints

Gets the reverse_connection_endpoints of this CreateOpensearchClusterPipelineDetails.

subnet_compartment_id

Gets the subnet_compartment_id of this CreateOpensearchClusterPipelineDetails.

subnet_id

Gets the subnet_id of this CreateOpensearchClusterPipelineDetails.

vcn_compartment_id

Gets the vcn_compartment_id of this CreateOpensearchClusterPipelineDetails.

vcn_id

Gets the vcn_id of this CreateOpensearchClusterPipelineDetails.

__init__(**kwargs)

Initializes a new CreateOpensearchClusterPipelineDetails object with values from keyword arguments. The following keyword arguments are supported (corresponding to the getters/setters of this class):

Parameters
  • display_name (str) – The value to assign to the display_name property of this CreateOpensearchClusterPipelineDetails.

  • ocpu_count (int) – The value to assign to the ocpu_count property of this CreateOpensearchClusterPipelineDetails.

  • memory_gb (int) – The value to assign to the memory_gb property of this CreateOpensearchClusterPipelineDetails.

  • node_count (int) – The value to assign to the node_count property of this CreateOpensearchClusterPipelineDetails.

  • node_shape (str) – The value to assign to the node_shape property of this CreateOpensearchClusterPipelineDetails.

  • pipeline_configuration_body (str) – The value to assign to the pipeline_configuration_body property of this CreateOpensearchClusterPipelineDetails.

  • data_prepper_configuration_body (str) – The value to assign to the data_prepper_configuration_body property of this CreateOpensearchClusterPipelineDetails.

  • compartment_id (str) – The value to assign to the compartment_id property of this CreateOpensearchClusterPipelineDetails.

  • vcn_id (str) – The value to assign to the vcn_id property of this CreateOpensearchClusterPipelineDetails.

  • subnet_id (str) – The value to assign to the subnet_id property of this CreateOpensearchClusterPipelineDetails.

  • vcn_compartment_id (str) – The value to assign to the vcn_compartment_id property of this CreateOpensearchClusterPipelineDetails.

  • subnet_compartment_id (str) – The value to assign to the subnet_compartment_id property of this CreateOpensearchClusterPipelineDetails.

  • nsg_id (str) – The value to assign to the nsg_id property of this CreateOpensearchClusterPipelineDetails.

  • reverse_connection_endpoints (list[oci.opensearch.models.OpensearchPipelineReverseConnectionEndpoint]) – The value to assign to the reverse_connection_endpoints property of this CreateOpensearchClusterPipelineDetails.

  • freeform_tags (dict(str, str)) – The value to assign to the freeform_tags property of this CreateOpensearchClusterPipelineDetails.

  • defined_tags (dict(str, dict(str, object))) – The value to assign to the defined_tags property of this CreateOpensearchClusterPipelineDetails.

property compartment_id

[Required] Gets the compartment_id of this CreateOpensearchClusterPipelineDetails. The OCID of the compartment to create the pipeline in.

Returns

The compartment_id of this CreateOpensearchClusterPipelineDetails.

Return type

str

property data_prepper_configuration_body

[Required] Gets the data_prepper_configuration_body of this CreateOpensearchClusterPipelineDetails. The data prepper config in YAML format. The command accepts the data prepper config as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .

Returns

The data_prepper_configuration_body of this CreateOpensearchClusterPipelineDetails.

Return type

str

property defined_tags

Gets the defined_tags of this CreateOpensearchClusterPipelineDetails. Defined tags for this resource. Each key is predefined and scoped to a namespace. Example: {“foo-namespace”: {“bar-key”: “value”}}

Returns

The defined_tags of this CreateOpensearchClusterPipelineDetails.

Return type

dict(str, dict(str, object))

property display_name

[Required] Gets the display_name of this CreateOpensearchClusterPipelineDetails. The name of the cluster pipeline. Avoid entering confidential information.

Returns

The display_name of this CreateOpensearchClusterPipelineDetails.

Return type

str

property freeform_tags

Gets the freeform_tags of this CreateOpensearchClusterPipelineDetails. Simple key-value pair that is applied without any predefined name, type or scope. Exists for cross-compatibility only. Example: {“bar-key”: “value”}

Returns

The freeform_tags of this CreateOpensearchClusterPipelineDetails.

Return type

dict(str, str)

property memory_gb

[Required] Gets the memory_gb of this CreateOpensearchClusterPipelineDetails. The amount of memory in GB, for each pipeline node.

Returns

The memory_gb of this CreateOpensearchClusterPipelineDetails.

Return type

int

property node_count

[Required] Gets the node_count of this CreateOpensearchClusterPipelineDetails. The number of nodes configured for the pipeline.

Returns

The node_count of this CreateOpensearchClusterPipelineDetails.

Return type

int

property node_shape

Gets the node_shape of this CreateOpensearchClusterPipelineDetails. The pipeline node shape.

Returns

The node_shape of this CreateOpensearchClusterPipelineDetails.

Return type

str

property nsg_id

Gets the nsg_id of this CreateOpensearchClusterPipelineDetails. The OCID of the NSG where the pipeline private endpoint vnic will be attached.

Returns

The nsg_id of this CreateOpensearchClusterPipelineDetails.

Return type

str

property ocpu_count

[Required] Gets the ocpu_count of this CreateOpensearchClusterPipelineDetails. The number of OCPUs configured for each pipeline node.

Returns

The ocpu_count of this CreateOpensearchClusterPipelineDetails.

Return type

int

property pipeline_configuration_body

[Required] Gets the pipeline_configuration_body of this CreateOpensearchClusterPipelineDetails. The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with .

Returns

The pipeline_configuration_body of this CreateOpensearchClusterPipelineDetails.

Return type

str

property reverse_connection_endpoints

Gets the reverse_connection_endpoints of this CreateOpensearchClusterPipelineDetails. The customer IP and the corresponding fully qualified domain name that the pipeline will connect to.

Returns

The reverse_connection_endpoints of this CreateOpensearchClusterPipelineDetails.

Return type

list[oci.opensearch.models.OpensearchPipelineReverseConnectionEndpoint]

property subnet_compartment_id

Gets the subnet_compartment_id of this CreateOpensearchClusterPipelineDetails. The OCID for the compartment where the pipeline’s subnet is located.

Returns

The subnet_compartment_id of this CreateOpensearchClusterPipelineDetails.

Return type

str

property subnet_id

Gets the subnet_id of this CreateOpensearchClusterPipelineDetails. The OCID of the pipeline’s subnet.

Returns

The subnet_id of this CreateOpensearchClusterPipelineDetails.

Return type

str

property vcn_compartment_id

Gets the vcn_compartment_id of this CreateOpensearchClusterPipelineDetails. The OCID for the compartment where the pipeline’s VCN is located.

Returns

The vcn_compartment_id of this CreateOpensearchClusterPipelineDetails.

Return type

str

property vcn_id

Gets the vcn_id of this CreateOpensearchClusterPipelineDetails. The OCID of the pipeline’s VCN.

Returns

The vcn_id of this CreateOpensearchClusterPipelineDetails.

Return type

str