feat(client-osis): Add Pipeline Role Arn as an optional parameter to the create / update pipeline APIs as an alternative to passing in the pipeline configuration body

Author: awstools

clients/client-osis/src/commands/CreatePipelineCommand.ts

@@ -71,6 +71,7 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
  *       Value: "STRING_VALUE", // required
  *     },
  *   ],
+ *   PipelineRoleArn: "STRING_VALUE",
  * };
  * const command = new CreatePipelineCommand(input);
  * const response = await client.send(command);
@@ -140,6 +141,7 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
  * //         Value: "STRING_VALUE", // required
  * //       },
  * //     ],
+ * //     PipelineRoleArn: "STRING_VALUE",
  * //   },
  * // };
  *

clients/client-osis/src/commands/GetPipelineCommand.ts

@@ -106,6 +106,7 @@ export interface GetPipelineCommandOutput extends GetPipelineResponse, __Metadat
  * //         Value: "STRING_VALUE", // required
  * //       },
  * //     ],
+ * //     PipelineRoleArn: "STRING_VALUE",
  * //   },
  * // };
  *

clients/client-osis/src/commands/StartPipelineCommand.ts

@@ -106,6 +106,7 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
  * //         Value: "STRING_VALUE", // required
  * //       },
  * //     ],
+ * //     PipelineRoleArn: "STRING_VALUE",
  * //   },
  * // };
  *

clients/client-osis/src/commands/StopPipelineCommand.ts

@@ -106,6 +106,7 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
  * //         Value: "STRING_VALUE", // required
  * //       },
  * //     ],
+ * //     PipelineRoleArn: "STRING_VALUE",
  * //   },
  * // };
  *

clients/client-osis/src/commands/UpdatePipelineCommand.ts

@@ -52,6 +52,7 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
  *   EncryptionAtRestOptions: { // EncryptionAtRestOptions
  *     KmsKeyArn: "STRING_VALUE", // required
  *   },
+ *   PipelineRoleArn: "STRING_VALUE",
  * };
  * const command = new UpdatePipelineCommand(input);
  * const response = await client.send(command);
@@ -121,6 +122,7 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
  * //         Value: "STRING_VALUE", // required
  * //       },
  * //     ],
+ * //     PipelineRoleArn: "STRING_VALUE",
  * //   },
  * // };
  *

clients/client-osis/src/models/models_0.ts

@@ -229,6 +229,14 @@ export interface CreatePipelineRequest {
    * @public
    */
   Tags?: Tag[] | undefined;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of an IAM role that provides
+   *    the required permissions for a pipeline to read from the source and write to the sink.
+   *    For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>
+   * @public
+   */
+  PipelineRoleArn?: string | undefined;
 }
 
 /**
@@ -453,6 +461,13 @@ export interface Pipeline {
    * @public
    */
   Tags?: Tag[] | undefined;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of the IAM role that provides
+   *    the required permissions for a pipeline to read from the source and write to the sink.</p>
+   * @public
+   */
+  PipelineRoleArn?: string | undefined;
 }
 
 /**
@@ -1170,6 +1185,14 @@ export interface UpdatePipelineRequest {
    * @public
    */
   EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
+
+  /**
+   * <p>The Amazon Resource Name (ARN) of an IAM role that provides
+   *    the required permissions for a pipeline to read from the source and write to the sink.
+   *    For more information, see <a href="https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>
+   * @public
+   */
+  PipelineRoleArn?: string | undefined;
 }
 
 /**

clients/client-osis/src/protocols/Aws_restJson1.ts

@@ -97,6 +97,7 @@ export const se_CreatePipelineCommand = async (
       MinUnits: [],
       PipelineConfigurationBody: [],
       PipelineName: [],
+      PipelineRoleArn: [],
       Tags: (_) => _json(_),
       VpcOptions: (_) => _json(_),
     })
@@ -328,6 +329,7 @@ export const se_UpdatePipelineCommand = async (
       MaxUnits: [],
       MinUnits: [],
       PipelineConfigurationBody: [],
+      PipelineRoleArn: [],
     })
   );
   b.m("PUT").h(headers).b(body);
@@ -957,6 +959,7 @@ const de_Pipeline = (output: any, context: __SerdeContext): Pipeline => {
     PipelineArn: __expectString,
     PipelineConfigurationBody: __expectString,
     PipelineName: __expectString,
+    PipelineRoleArn: __expectString,
     ServiceVpcEndpoints: _json,
     Status: __expectString,
     StatusReason: _json,

codegen/sdk-codegen/aws-models/osis.json

@@ -1065,6 +1065,12 @@
           "traits": {
             "smithy.api#documentation": "<p>List of tags to add to the pipeline upon creation.</p>"
           }
+        },
+        "PipelineRoleArn": {
+          "target": "com.amazonaws.osis#PipelineRoleArn",
+          "traits": {
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of an IAM role that provides\n   the required permissions for a pipeline to read from the source and write to the sink.\n   For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html\">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>"
+          }
         }
       },
       "traits": {
@@ -1796,6 +1802,12 @@
           "traits": {
             "smithy.api#documentation": "<p>A list of tags associated with the given pipeline.</p>"
           }
+        },
+        "PipelineRoleArn": {
+          "target": "com.amazonaws.osis#PipelineRoleArn",
+          "traits": {
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of the IAM role that provides\n   the required permissions for a pipeline to read from the source and write to the sink.</p>"
+          }
         }
       },
       "traits": {
@@ -1945,6 +1957,16 @@
         "smithy.api#pattern": "^[a-z][a-z0-9\\-]+$"
       }
     },
+    "com.amazonaws.osis#PipelineRoleArn": {
+      "type": "string",
+      "traits": {
+        "smithy.api#length": {
+          "min": 20,
+          "max": 2048
+        },
+        "smithy.api#pattern": "^arn:(aws|aws\\-cn|aws\\-us\\-gov|aws\\-iso|aws\\-iso\\-b|aws\\-iso\\-e|aws\\-iso\\-f):iam::[0-9]+:role\\/.*$"
+      }
+    },
     "com.amazonaws.osis#PipelineStatus": {
       "type": "enum",
       "members": {
@@ -2601,6 +2623,12 @@
           "traits": {
             "smithy.api#documentation": "<p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p>"
           }
+        },
+        "PipelineRoleArn": {
+          "target": "com.amazonaws.osis#PipelineRoleArn",
+          "traits": {
+            "smithy.api#documentation": "<p>The Amazon Resource Name (ARN) of an IAM role that provides\n   the required permissions for a pipeline to read from the source and write to the sink.\n   For more information, see <a href=\"https://docs.aws.amazon.com/opensearch-service/latest/developerguide/pipeline-security-overview.html\">Setting up roles and users in Amazon OpenSearch Ingestion</a>.</p>"
+          }
         }
       },
       "traits": {