add-flow-to-deployment¶

Description¶

Adds a flow to an existing deployment.

Synopsis¶

  add-flow-to-deployment
--environment-crn <value>
--name <value>
--configuration-version <value>
--deployment-crn <value>
--deployed-flow-request-crn <value>
[--parameter-groups <value>]
[--kpis <value>]
[--auto-start-flow | --no-auto-start-flow]
[--ignore-custom-nar-configuration-check | --no-ignore-custom-nar-configuration-check]
[--ignore-custom-python-configuration-check | --no-ignore-custom-python-configuration-check]
[--ignore-deployment-inbound-configuration-checks | --no-ignore-deployment-inbound-configuration-checks]
[--project-crn <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton]

Options¶

--environment-crn (string)

The CRN of an environment to execute the command.

--name (string)

The name of the deployed NiFi flow.

--configuration-version (integer)

The version of this configuration.

--deployment-crn (string)

The CRN of the deployment.

--deployed-flow-request-crn (string)

The CRN of the flow deployment request.

--parameter-groups (array)

The list of flow parameter groups.

JSON Syntax:

[
  {
    "name": "string",
    "parameters": [
      {
        "name": "string",
        "description": "string",
        "value": "string",
        "sensitive": true|false,
        "type": "TEXT"|"FILE"|"FILES",
        "assetReferences": [
          { ... recursive ... }
          ...
        ],
        "valueSet": true|false,
        "sourceParameterGroupId": "string"
      }
      ...
    ],
    "inheritedParameterGroups": [
      {
        "groupId": "string",
        "version": integer
      }
      ...
    ],
    "otherName": "string"
  }
  ...
]

--kpis (array)

The list of configured KPIs.

JSON Syntax:

[
  {
    "metricId": "string",
    "id": "string",
    "metricComponentType": "SYSTEM"|"NIFI_FLOW"|"NIFI_PROCESSOR"|"NIFI_PROCESS_GROUP"|"NIFI_CONNECTION",
    "alert": {
      "thresholdMoreThan": {
        "unitId": "string",
        "value": double
      },
      "thresholdLessThan": {
        "unitId": "string",
        "value": double
      },
      "frequencyTolerance": {
        "unit": {
          "id": "SECONDS"|"MINUTES"|"HOURS"|"DAYS",
          "label": "string",
          "abbreviation": "string"
        },
        "value": double
      }
    },
    "componentId": "string"
  }
  ...
]

--auto-start-flow | --no-auto-start-flow (boolean)

Indicates whether or not the flow should be started during deployment creation.

--ignore-custom-nar-configuration-check | --no-ignore-custom-nar-configuration-check (boolean)

When specified, ignore the check to validate if deployment has custom NARs configured when the flow definition contains custom components.

--ignore-custom-python-configuration-check | --no-ignore-custom-python-configuration-check (boolean)

When specified, ignore the check to validate if deployment has custom Python configured when the flow definition contains custom Python processors.

--ignore-deployment-inbound-configuration-checks | --no-ignore-deployment-inbound-configuration-checks (boolean)

When specified, ignore the check to validate if deployment has inbound connection configured for all listen components.

--project-crn (string)

The CRN of the project to which the deployment belongs, used for authorization.

--cli-input-json (string)

Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values.

--generate-cli-skeleton (boolean)

Prints a sample input JSON to standard output. Note the specified operation is not run if this argument is specified. The sample input can be used as an argument for --cli-input-json.

Output¶

deployedFlow -> (object)

Provides details about a deployed flow.

status -> (object)

The state and state message associated with a deployed flow.

state -> (string)

The state that the deployed flow is currently in.

detailedState -> (string)

The detailed state that the deployed flow is currently in.

message -> (string)

Detail message relating to the current status of the deployed flow.

configurationVersion -> (integer)

The version of this configuration.

targetProcessGroupId -> (string)

The id of the process group in NiFi.

name -> (string)

The name of the deployed flow.

activeInfoAlertCount -> (integer)

Current count of active alerts classified as an info.

activeWarningAlertCount -> (integer)

Current count of active alerts classified as a warning.

activeErrorAlertCount -> (integer)

Current count of active alerts classified as an error.

environmentId -> (string)

The id of the environment.

environment -> (object)

Metadata about the workload.

crn -> (string)

The CRN of the environment.

name -> (string)

The name of the environment.

cloudPlatform -> (string)

The cloudPlatform flag of the environment.

region -> (object)

A cloud region

name -> (string)

Name of the cloud region

displayName -> (string)

Display-friendly name of the cloud region

cloudbreakCrn -> (string)

Crn of associated cloudbreak environment.

id -> (string)

The internal ID of the environment.

localUrl -> (string)

The DataFlow Service contact url.

workloadVersion -> (string)

The version of the DataFlow Service.

environmentStatus -> (object)

Environment status.

detailedState -> (string)

The detailed state that the environment is currently in.

message -> (string)

Detail message relating to the current status of the environment.

state -> (string)

The state that the environment is currently in.

accountId -> (string)

The account ID from the CRN.

deploymentName -> (string)

The name of the deployment.

crn -> (string)

The CRN of the deployed flow.

project -> (object)

The meta information about a project.

id -> (string)

The id of the project

crn -> (string)

The CRN of the project

name -> (string)

The name of the group

artifactName -> (string)

The name of the flow definition.

catalogItemId -> (string)

The id of the catalog item. Will either be the flow definition id or the id of the imported ready flow.

flowVersion -> (integer)

The version of the flow.

flowVersionCrn -> (string)

The deployed flow definition version CRN.

flowCrn -> (string)

The deployed flow definition CRN.

creatorCrn -> (string)

The CRN of the user who deployed the flow.

artifactTypeName -> (string)

The type of artifact of the flow definition.

deployedByUsername -> (string)

The username of the person who deployed the flow.

deployedByName -> (string)

The name of the person who deployed the flow.

created -> (integer)

Timestamp of the first time the flow deployed into a NiFi cluster.

updated -> (integer)

Timestamp of the last time the deployed flow was modified.

validActions -> (array)

Valid actions that can be applied to the deployed flow in its current state.

item -> (string)

dataSent -> (array)

The dataSent values, if requested.

item -> (object)

A metric value.

timestamp -> (integer)

Timestamp of the metric value.

value -> (double)

The value of the metric.

dataReceived -> (array)

The dataReceived values, if requested.

item -> (object)

A metric value.

timestamp -> (integer)

Timestamp of the metric value.

value -> (double)

The value of the metric.

projectCrn -> (string)

The crn of the project this flow belongs to, or null if does not belong to a project.

deploymentCrn -> (string)

The crn of the deployment this flow belongs to.

Form Factors¶

public