Skip to content

Commit 36ca668

Browse files
author
awstools
committed
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
1 parent 5c5e7ce commit 36ca668

File tree

8 files changed

+61
-0
lines changed

8 files changed

+61
-0
lines changed

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,7 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
7171
* Value: "STRING_VALUE", // required
7272
* },
7373
* ],
74+
* PipelineRoleArn: "STRING_VALUE",
7475
* };
7576
* const command = new CreatePipelineCommand(input);
7677
* const response = await client.send(command);
@@ -140,6 +141,7 @@ export interface CreatePipelineCommandOutput extends CreatePipelineResponse, __M
140141
* // Value: "STRING_VALUE", // required
141142
* // },
142143
* // ],
144+
* // PipelineRoleArn: "STRING_VALUE",
143145
* // },
144146
* // };
145147
*

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ export interface GetPipelineCommandOutput extends GetPipelineResponse, __Metadat
106106
* // Value: "STRING_VALUE", // required
107107
* // },
108108
* // ],
109+
* // PipelineRoleArn: "STRING_VALUE",
109110
* // },
110111
* // };
111112
*

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ export interface StartPipelineCommandOutput extends StartPipelineResponse, __Met
106106
* // Value: "STRING_VALUE", // required
107107
* // },
108108
* // ],
109+
* // PipelineRoleArn: "STRING_VALUE",
109110
* // },
110111
* // };
111112
*

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

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,7 @@ export interface StopPipelineCommandOutput extends StopPipelineResponse, __Metad
106106
* // Value: "STRING_VALUE", // required
107107
* // },
108108
* // ],
109+
* // PipelineRoleArn: "STRING_VALUE",
109110
* // },
110111
* // };
111112
*

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,7 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
5252
* EncryptionAtRestOptions: { // EncryptionAtRestOptions
5353
* KmsKeyArn: "STRING_VALUE", // required
5454
* },
55+
* PipelineRoleArn: "STRING_VALUE",
5556
* };
5657
* const command = new UpdatePipelineCommand(input);
5758
* const response = await client.send(command);
@@ -121,6 +122,7 @@ export interface UpdatePipelineCommandOutput extends UpdatePipelineResponse, __M
121122
* // Value: "STRING_VALUE", // required
122123
* // },
123124
* // ],
125+
* // PipelineRoleArn: "STRING_VALUE",
124126
* // },
125127
* // };
126128
*

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

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -229,6 +229,14 @@ export interface CreatePipelineRequest {
229229
* @public
230230
*/
231231
Tags?: Tag[] | undefined;
232+
233+
/**
234+
* <p>The Amazon Resource Name (ARN) of an IAM role that provides
235+
* the required permissions for a pipeline to read from the source and write to the sink.
236+
* 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>
237+
* @public
238+
*/
239+
PipelineRoleArn?: string | undefined;
232240
}
233241

234242
/**
@@ -453,6 +461,13 @@ export interface Pipeline {
453461
* @public
454462
*/
455463
Tags?: Tag[] | undefined;
464+
465+
/**
466+
* <p>The Amazon Resource Name (ARN) of the IAM role that provides
467+
* the required permissions for a pipeline to read from the source and write to the sink.</p>
468+
* @public
469+
*/
470+
PipelineRoleArn?: string | undefined;
456471
}
457472

458473
/**
@@ -1170,6 +1185,14 @@ export interface UpdatePipelineRequest {
11701185
* @public
11711186
*/
11721187
EncryptionAtRestOptions?: EncryptionAtRestOptions | undefined;
1188+
1189+
/**
1190+
* <p>The Amazon Resource Name (ARN) of an IAM role that provides
1191+
* the required permissions for a pipeline to read from the source and write to the sink.
1192+
* 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>
1193+
* @public
1194+
*/
1195+
PipelineRoleArn?: string | undefined;
11731196
}
11741197

11751198
/**

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

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ export const se_CreatePipelineCommand = async (
9797
MinUnits: [],
9898
PipelineConfigurationBody: [],
9999
PipelineName: [],
100+
PipelineRoleArn: [],
100101
Tags: (_) => _json(_),
101102
VpcOptions: (_) => _json(_),
102103
})
@@ -328,6 +329,7 @@ export const se_UpdatePipelineCommand = async (
328329
MaxUnits: [],
329330
MinUnits: [],
330331
PipelineConfigurationBody: [],
332+
PipelineRoleArn: [],
331333
})
332334
);
333335
b.m("PUT").h(headers).b(body);
@@ -957,6 +959,7 @@ const de_Pipeline = (output: any, context: __SerdeContext): Pipeline => {
957959
PipelineArn: __expectString,
958960
PipelineConfigurationBody: __expectString,
959961
PipelineName: __expectString,
962+
PipelineRoleArn: __expectString,
960963
ServiceVpcEndpoints: _json,
961964
Status: __expectString,
962965
StatusReason: _json,

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

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1065,6 +1065,12 @@
10651065
"traits": {
10661066
"smithy.api#documentation": "<p>List of tags to add to the pipeline upon creation.</p>"
10671067
}
1068+
},
1069+
"PipelineRoleArn": {
1070+
"target": "com.amazonaws.osis#PipelineRoleArn",
1071+
"traits": {
1072+
"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>"
1073+
}
10681074
}
10691075
},
10701076
"traits": {
@@ -1796,6 +1802,12 @@
17961802
"traits": {
17971803
"smithy.api#documentation": "<p>A list of tags associated with the given pipeline.</p>"
17981804
}
1805+
},
1806+
"PipelineRoleArn": {
1807+
"target": "com.amazonaws.osis#PipelineRoleArn",
1808+
"traits": {
1809+
"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>"
1810+
}
17991811
}
18001812
},
18011813
"traits": {
@@ -1945,6 +1957,16 @@
19451957
"smithy.api#pattern": "^[a-z][a-z0-9\\-]+$"
19461958
}
19471959
},
1960+
"com.amazonaws.osis#PipelineRoleArn": {
1961+
"type": "string",
1962+
"traits": {
1963+
"smithy.api#length": {
1964+
"min": 20,
1965+
"max": 2048
1966+
},
1967+
"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\\/.*$"
1968+
}
1969+
},
19481970
"com.amazonaws.osis#PipelineStatus": {
19491971
"type": "enum",
19501972
"members": {
@@ -2601,6 +2623,12 @@
26012623
"traits": {
26022624
"smithy.api#documentation": "<p>Key-value pairs to configure encryption for data that is written to a persistent buffer.</p>"
26032625
}
2626+
},
2627+
"PipelineRoleArn": {
2628+
"target": "com.amazonaws.osis#PipelineRoleArn",
2629+
"traits": {
2630+
"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>"
2631+
}
26042632
}
26052633
},
26062634
"traits": {

0 commit comments

Comments
 (0)