cdk-docker-image-deployment 0.0.88 → 0.0.89
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.jsii +3 -3
- package/lib/destination.js +1 -1
- package/lib/docker-image-deployment.js +1 -1
- package/lib/source.js +1 -1
- package/node_modules/aws-sdk/CHANGELOG.md +29 -1
- package/node_modules/aws-sdk/README.md +1 -1
- package/node_modules/aws-sdk/apis/arc-zonal-shift-2022-10-30.examples.json +5 -0
- package/node_modules/aws-sdk/apis/arc-zonal-shift-2022-10-30.min.json +284 -0
- package/node_modules/aws-sdk/apis/arc-zonal-shift-2022-10-30.paginators.json +16 -0
- package/node_modules/aws-sdk/apis/compute-optimizer-2019-11-01.min.json +31 -13
- package/node_modules/aws-sdk/apis/config-2014-11-12.min.json +282 -134
- package/node_modules/aws-sdk/apis/config-2014-11-12.paginators.json +6 -0
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.min.json +2824 -1317
- package/node_modules/aws-sdk/apis/ec2-2016-11-15.paginators.json +42 -0
- package/node_modules/aws-sdk/apis/eks-2017-11-01.min.json +87 -52
- package/node_modules/aws-sdk/apis/firehose-2015-08-04.min.json +128 -27
- package/node_modules/aws-sdk/apis/fsx-2018-03-01.min.json +156 -130
- package/node_modules/aws-sdk/apis/glue-2017-03-31.min.json +341 -298
- package/node_modules/aws-sdk/apis/inspector2-2020-06-08.min.json +205 -28
- package/node_modules/aws-sdk/apis/kms-2014-11-01.examples.json +359 -50
- package/node_modules/aws-sdk/apis/kms-2014-11-01.min.json +127 -72
- package/node_modules/aws-sdk/apis/kms-2014-11-01.paginators.json +0 -7
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.min.json +69 -50
- package/node_modules/aws-sdk/apis/lambda-2015-03-31.waiters2.json +26 -0
- package/node_modules/aws-sdk/apis/license-manager-user-subscriptions-2018-05-10.min.json +82 -9
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.min.json +793 -112
- package/node_modules/aws-sdk/apis/macie2-2020-01-01.paginators.json +33 -0
- package/node_modules/aws-sdk/apis/metadata.json +16 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.examples.json +5 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.min.json +3722 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.paginators.json +100 -0
- package/node_modules/aws-sdk/apis/omics-2022-11-28.waiters2.json +498 -0
- package/node_modules/aws-sdk/apis/opensearchserverless-2021-11-01.examples.json +5 -0
- package/node_modules/aws-sdk/apis/opensearchserverless-2021-11-01.min.json +1082 -0
- package/node_modules/aws-sdk/apis/opensearchserverless-2021-11-01.paginators.json +29 -0
- package/node_modules/aws-sdk/apis/quicksight-2018-04-01.min.json +5991 -325
- package/node_modules/aws-sdk/apis/s3control-2018-08-20.min.json +138 -28
- package/node_modules/aws-sdk/apis/securityhub-2018-10-26.min.json +23 -16
- package/node_modules/aws-sdk/apis/securitylake-2018-05-10.examples.json +5 -0
- package/node_modules/aws-sdk/apis/securitylake-2018-05-10.min.json +1041 -0
- package/node_modules/aws-sdk/apis/securitylake-2018-05-10.paginators.json +28 -0
- package/node_modules/aws-sdk/apis/simspaceweaver-2022-10-28.examples.json +5 -0
- package/node_modules/aws-sdk/apis/simspaceweaver-2022-10-28.min.json +578 -0
- package/node_modules/aws-sdk/apis/simspaceweaver-2022-10-28.paginators.json +14 -0
- package/node_modules/aws-sdk/clients/all.d.ts +5 -0
- package/node_modules/aws-sdk/clients/all.js +6 -1
- package/node_modules/aws-sdk/clients/arczonalshift.d.ts +309 -0
- package/node_modules/aws-sdk/clients/arczonalshift.js +18 -0
- package/node_modules/aws-sdk/clients/computeoptimizer.d.ts +28 -5
- package/node_modules/aws-sdk/clients/configservice.d.ts +233 -6
- package/node_modules/aws-sdk/clients/ec2.d.ts +1851 -20
- package/node_modules/aws-sdk/clients/eks.d.ts +58 -8
- package/node_modules/aws-sdk/clients/firehose.d.ts +263 -48
- package/node_modules/aws-sdk/clients/fsx.d.ts +70 -21
- package/node_modules/aws-sdk/clients/glue.d.ts +66 -0
- package/node_modules/aws-sdk/clients/inspector2.d.ts +289 -15
- package/node_modules/aws-sdk/clients/kms.d.ts +198 -92
- package/node_modules/aws-sdk/clients/lambda.d.ts +132 -94
- package/node_modules/aws-sdk/clients/licensemanagerusersubscriptions.d.ts +62 -4
- package/node_modules/aws-sdk/clients/macie2.d.ts +637 -54
- package/node_modules/aws-sdk/clients/omics.d.ts +4175 -0
- package/node_modules/aws-sdk/clients/omics.js +19 -0
- package/node_modules/aws-sdk/clients/opensearchserverless.d.ts +1508 -0
- package/node_modules/aws-sdk/clients/opensearchserverless.js +18 -0
- package/node_modules/aws-sdk/clients/quicksight.d.ts +9833 -2835
- package/node_modules/aws-sdk/clients/s3control.d.ts +69 -0
- package/node_modules/aws-sdk/clients/securityhub.d.ts +14 -0
- package/node_modules/aws-sdk/clients/securitylake.d.ts +1049 -0
- package/node_modules/aws-sdk/clients/securitylake.js +18 -0
- package/node_modules/aws-sdk/clients/simspaceweaver.d.ts +647 -0
- package/node_modules/aws-sdk/clients/simspaceweaver.js +18 -0
- package/node_modules/aws-sdk/dist/aws-sdk-core-react-native.js +39 -13
- package/node_modules/aws-sdk/dist/aws-sdk-react-native.js +264 -37
- package/node_modules/aws-sdk/dist/aws-sdk.js +3615 -1676
- package/node_modules/aws-sdk/dist/aws-sdk.min.js +79 -78
- package/node_modules/aws-sdk/lib/config_service_placeholders.d.ts +10 -0
- package/node_modules/aws-sdk/lib/core.d.ts +4 -0
- package/node_modules/aws-sdk/lib/core.js +1 -1
- package/node_modules/aws-sdk/lib/event_listeners.js +26 -9
- package/node_modules/aws-sdk/lib/region_config.js +11 -2
- package/node_modules/aws-sdk/package.json +1 -1
- package/package.json +3 -3
|
@@ -12,11 +12,11 @@ declare class Firehose extends Service {
|
|
|
12
12
|
constructor(options?: Firehose.Types.ClientConfiguration)
|
|
13
13
|
config: Config & Firehose.Types.ClientConfiguration;
|
|
14
14
|
/**
|
|
15
|
-
* Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per
|
|
15
|
+
* Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
|
|
16
16
|
*/
|
|
17
17
|
createDeliveryStream(params: Firehose.Types.CreateDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request<Firehose.Types.CreateDeliveryStreamOutput, AWSError>;
|
|
18
18
|
/**
|
|
19
|
-
* Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per
|
|
19
|
+
* Creates a Kinesis Data Firehose delivery stream. By default, you can create up to 50 delivery streams per Amazon Web Services Region. This is an asynchronous operation that immediately returns. The initial status of the delivery stream is CREATING. After the delivery stream is created, its status is ACTIVE and it now accepts data. If the delivery stream creation fails, the status transitions to CREATING_FAILED. Attempts to send data to a delivery stream that is not in the ACTIVE state cause an exception. To check the state of a delivery stream, use DescribeDeliveryStream. If the status of a delivery stream is CREATING_FAILED, this status doesn't change, and you can't invoke CreateDeliveryStream again on it. However, you can invoke the DeleteDeliveryStream operation to delete it. A Kinesis Data Firehose delivery stream can be configured to receive records directly from providers using PutRecord or PutRecordBatch, or it can be configured to use an existing Kinesis stream as its source. To specify a Kinesis data stream as input, set the DeliveryStreamType parameter to KinesisStreamAsSource, and provide the Kinesis stream Amazon Resource Name (ARN) and role ARN in the KinesisStreamSourceConfiguration parameter. To create a delivery stream with server-side encryption (SSE) enabled, include DeliveryStreamEncryptionConfigurationInput in your request. This is optional. You can also invoke StartDeliveryStreamEncryption to turn on SSE for an existing delivery stream that doesn't have SSE enabled. A delivery stream is configured with a single destination: Amazon S3, Amazon ES, Amazon Redshift, or Splunk. You must specify only one of the following destination configuration parameters: ExtendedS3DestinationConfiguration, S3DestinationConfiguration, ElasticsearchDestinationConfiguration, RedshiftDestinationConfiguration, or SplunkDestinationConfiguration. When you specify S3DestinationConfiguration, you can also provide the following optional values: BufferingHints, EncryptionConfiguration, and CompressionFormat. By default, if no BufferingHints value is provided, Kinesis Data Firehose buffers data up to 5 MB or for 5 minutes, whichever condition is satisfied first. BufferingHints is a hint, so there are some cases where the service cannot adhere to these conditions strictly. For example, record boundaries might be such that the size is a little over or under the configured buffering size. By default, no encryption is performed. We strongly recommend that you enable encryption to ensure secure data storage in Amazon S3. A few notes about Amazon Redshift as a destination: An Amazon Redshift destination requires an S3 bucket as intermediate location. Kinesis Data Firehose first delivers data to Amazon S3 and then uses COPY syntax to load data into an Amazon Redshift table. This is specified in the RedshiftDestinationConfiguration.S3Configuration parameter. The compression formats SNAPPY or ZIP cannot be specified in RedshiftDestinationConfiguration.S3Configuration because the Amazon Redshift COPY operation that reads from the S3 bucket doesn't support these compression formats. We strongly recommend that you use the user name and password you provide exclusively with Kinesis Data Firehose, and that the permissions for the account are restricted for Amazon Redshift INSERT permissions. Kinesis Data Firehose assumes the IAM role that is configured as part of the destination. The role should allow the Kinesis Data Firehose principal to assume the role, and the role should have permissions that allow the service to deliver the data. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination in the Amazon Kinesis Data Firehose Developer Guide.
|
|
20
20
|
*/
|
|
21
21
|
createDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.CreateDeliveryStreamOutput) => void): Request<Firehose.Types.CreateDeliveryStreamOutput, AWSError>;
|
|
22
22
|
/**
|
|
@@ -84,11 +84,11 @@ declare class Firehose extends Service {
|
|
|
84
84
|
*/
|
|
85
85
|
stopDeliveryStreamEncryption(callback?: (err: AWSError, data: Firehose.Types.StopDeliveryStreamEncryptionOutput) => void): Request<Firehose.Types.StopDeliveryStreamEncryptionOutput, AWSError>;
|
|
86
86
|
/**
|
|
87
|
-
* Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to
|
|
87
|
+
* Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide. Each delivery stream can have up to 50 tags. This operation has a limit of five transactions per second per account.
|
|
88
88
|
*/
|
|
89
89
|
tagDeliveryStream(params: Firehose.Types.TagDeliveryStreamInput, callback?: (err: AWSError, data: Firehose.Types.TagDeliveryStreamOutput) => void): Request<Firehose.Types.TagDeliveryStreamOutput, AWSError>;
|
|
90
90
|
/**
|
|
91
|
-
* Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to
|
|
91
|
+
* Adds or updates tags for the specified delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. If you specify a tag that already exists, the tag value is replaced with the value that you specify in the request. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide. Each delivery stream can have up to 50 tags. This operation has a limit of five transactions per second per account.
|
|
92
92
|
*/
|
|
93
93
|
tagDeliveryStream(callback?: (err: AWSError, data: Firehose.Types.TagDeliveryStreamOutput) => void): Request<Firehose.Types.TagDeliveryStreamOutput, AWSError>;
|
|
94
94
|
/**
|
|
@@ -110,22 +110,162 @@ declare class Firehose extends Service {
|
|
|
110
110
|
}
|
|
111
111
|
declare namespace Firehose {
|
|
112
112
|
export type AWSKMSKeyARN = string;
|
|
113
|
+
export interface AmazonOpenSearchServerlessBufferingHints {
|
|
114
|
+
/**
|
|
115
|
+
* Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
|
|
116
|
+
*/
|
|
117
|
+
IntervalInSeconds?: AmazonOpenSearchServerlessBufferingIntervalInSeconds;
|
|
118
|
+
/**
|
|
119
|
+
* Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
|
|
120
|
+
*/
|
|
121
|
+
SizeInMBs?: AmazonOpenSearchServerlessBufferingSizeInMBs;
|
|
122
|
+
}
|
|
123
|
+
export type AmazonOpenSearchServerlessBufferingIntervalInSeconds = number;
|
|
124
|
+
export type AmazonOpenSearchServerlessBufferingSizeInMBs = number;
|
|
125
|
+
export type AmazonOpenSearchServerlessCollectionEndpoint = string;
|
|
126
|
+
export interface AmazonOpenSearchServerlessDestinationConfiguration {
|
|
127
|
+
/**
|
|
128
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
|
|
129
|
+
*/
|
|
130
|
+
RoleARN: RoleARN;
|
|
131
|
+
/**
|
|
132
|
+
* The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
|
|
133
|
+
*/
|
|
134
|
+
CollectionEndpoint?: AmazonOpenSearchServerlessCollectionEndpoint;
|
|
135
|
+
/**
|
|
136
|
+
* The Serverless offering for Amazon OpenSearch Service index name.
|
|
137
|
+
*/
|
|
138
|
+
IndexName: AmazonOpenSearchServerlessIndexName;
|
|
139
|
+
/**
|
|
140
|
+
* The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
|
|
141
|
+
*/
|
|
142
|
+
BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
|
|
143
|
+
/**
|
|
144
|
+
* The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
|
145
|
+
*/
|
|
146
|
+
RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
|
|
147
|
+
/**
|
|
148
|
+
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
|
|
149
|
+
*/
|
|
150
|
+
S3BackupMode?: AmazonOpenSearchServerlessS3BackupMode;
|
|
151
|
+
S3Configuration: S3DestinationConfiguration;
|
|
152
|
+
ProcessingConfiguration?: ProcessingConfiguration;
|
|
153
|
+
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
154
|
+
VpcConfiguration?: VpcConfiguration;
|
|
155
|
+
}
|
|
156
|
+
export interface AmazonOpenSearchServerlessDestinationDescription {
|
|
157
|
+
/**
|
|
158
|
+
* The Amazon Resource Name (ARN) of the AWS credentials.
|
|
159
|
+
*/
|
|
160
|
+
RoleARN?: RoleARN;
|
|
161
|
+
/**
|
|
162
|
+
* The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
|
|
163
|
+
*/
|
|
164
|
+
CollectionEndpoint?: AmazonOpenSearchServerlessCollectionEndpoint;
|
|
165
|
+
/**
|
|
166
|
+
* The Serverless offering for Amazon OpenSearch Service index name.
|
|
167
|
+
*/
|
|
168
|
+
IndexName?: AmazonOpenSearchServerlessIndexName;
|
|
169
|
+
/**
|
|
170
|
+
* The buffering options.
|
|
171
|
+
*/
|
|
172
|
+
BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
|
|
173
|
+
/**
|
|
174
|
+
* The Serverless offering for Amazon OpenSearch Service retry options.
|
|
175
|
+
*/
|
|
176
|
+
RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
|
|
177
|
+
/**
|
|
178
|
+
* The Amazon S3 backup mode.
|
|
179
|
+
*/
|
|
180
|
+
S3BackupMode?: AmazonOpenSearchServerlessS3BackupMode;
|
|
181
|
+
S3DestinationDescription?: S3DestinationDescription;
|
|
182
|
+
ProcessingConfiguration?: ProcessingConfiguration;
|
|
183
|
+
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
184
|
+
VpcConfigurationDescription?: VpcConfigurationDescription;
|
|
185
|
+
}
|
|
186
|
+
export interface AmazonOpenSearchServerlessDestinationUpdate {
|
|
187
|
+
/**
|
|
188
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
|
|
189
|
+
*/
|
|
190
|
+
RoleARN?: RoleARN;
|
|
191
|
+
/**
|
|
192
|
+
* The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
|
|
193
|
+
*/
|
|
194
|
+
CollectionEndpoint?: AmazonOpenSearchServerlessCollectionEndpoint;
|
|
195
|
+
/**
|
|
196
|
+
* The Serverless offering for Amazon OpenSearch Service index name.
|
|
197
|
+
*/
|
|
198
|
+
IndexName?: AmazonOpenSearchServerlessIndexName;
|
|
199
|
+
/**
|
|
200
|
+
* The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
|
|
201
|
+
*/
|
|
202
|
+
BufferingHints?: AmazonOpenSearchServerlessBufferingHints;
|
|
203
|
+
/**
|
|
204
|
+
* The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
|
205
|
+
*/
|
|
206
|
+
RetryOptions?: AmazonOpenSearchServerlessRetryOptions;
|
|
207
|
+
S3Update?: S3DestinationUpdate;
|
|
208
|
+
ProcessingConfiguration?: ProcessingConfiguration;
|
|
209
|
+
CloudWatchLoggingOptions?: CloudWatchLoggingOptions;
|
|
210
|
+
}
|
|
211
|
+
export type AmazonOpenSearchServerlessIndexName = string;
|
|
212
|
+
export type AmazonOpenSearchServerlessRetryDurationInSeconds = number;
|
|
213
|
+
export interface AmazonOpenSearchServerlessRetryOptions {
|
|
214
|
+
/**
|
|
215
|
+
* After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
|
|
216
|
+
*/
|
|
217
|
+
DurationInSeconds?: AmazonOpenSearchServerlessRetryDurationInSeconds;
|
|
218
|
+
}
|
|
219
|
+
export type AmazonOpenSearchServerlessS3BackupMode = "FailedDocumentsOnly"|"AllDocuments"|string;
|
|
113
220
|
export interface AmazonopensearchserviceBufferingHints {
|
|
221
|
+
/**
|
|
222
|
+
* Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
|
|
223
|
+
*/
|
|
114
224
|
IntervalInSeconds?: AmazonopensearchserviceBufferingIntervalInSeconds;
|
|
225
|
+
/**
|
|
226
|
+
* Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5. We recommend setting this parameter to a value greater than the amount of data you typically ingest into the delivery stream in 10 seconds. For example, if you typically ingest data at 1 MB/sec, the value should be 10 MB or higher.
|
|
227
|
+
*/
|
|
115
228
|
SizeInMBs?: AmazonopensearchserviceBufferingSizeInMBs;
|
|
116
229
|
}
|
|
117
230
|
export type AmazonopensearchserviceBufferingIntervalInSeconds = number;
|
|
118
231
|
export type AmazonopensearchserviceBufferingSizeInMBs = number;
|
|
119
232
|
export type AmazonopensearchserviceClusterEndpoint = string;
|
|
120
233
|
export interface AmazonopensearchserviceDestinationConfiguration {
|
|
234
|
+
/**
|
|
235
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
|
|
236
|
+
*/
|
|
121
237
|
RoleARN: RoleARN;
|
|
238
|
+
/**
|
|
239
|
+
* The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeElasticsearchDomain, DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN.
|
|
240
|
+
*/
|
|
122
241
|
DomainARN?: AmazonopensearchserviceDomainARN;
|
|
242
|
+
/**
|
|
243
|
+
* The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
|
|
244
|
+
*/
|
|
123
245
|
ClusterEndpoint?: AmazonopensearchserviceClusterEndpoint;
|
|
246
|
+
/**
|
|
247
|
+
* The ElasticsearAmazon OpenSearch Service index name.
|
|
248
|
+
*/
|
|
124
249
|
IndexName: AmazonopensearchserviceIndexName;
|
|
250
|
+
/**
|
|
251
|
+
* The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during run time.
|
|
252
|
+
*/
|
|
125
253
|
TypeName?: AmazonopensearchserviceTypeName;
|
|
254
|
+
/**
|
|
255
|
+
* The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
|
|
256
|
+
*/
|
|
126
257
|
IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod;
|
|
258
|
+
/**
|
|
259
|
+
* The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
|
|
260
|
+
*/
|
|
127
261
|
BufferingHints?: AmazonopensearchserviceBufferingHints;
|
|
262
|
+
/**
|
|
263
|
+
* The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
|
264
|
+
*/
|
|
128
265
|
RetryOptions?: AmazonopensearchserviceRetryOptions;
|
|
266
|
+
/**
|
|
267
|
+
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
|
|
268
|
+
*/
|
|
129
269
|
S3BackupMode?: AmazonopensearchserviceS3BackupMode;
|
|
130
270
|
S3Configuration: S3DestinationConfiguration;
|
|
131
271
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
@@ -133,14 +273,41 @@ declare namespace Firehose {
|
|
|
133
273
|
VpcConfiguration?: VpcConfiguration;
|
|
134
274
|
}
|
|
135
275
|
export interface AmazonopensearchserviceDestinationDescription {
|
|
276
|
+
/**
|
|
277
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
|
|
278
|
+
*/
|
|
136
279
|
RoleARN?: RoleARN;
|
|
280
|
+
/**
|
|
281
|
+
* The ARN of the Amazon OpenSearch Service domain.
|
|
282
|
+
*/
|
|
137
283
|
DomainARN?: AmazonopensearchserviceDomainARN;
|
|
284
|
+
/**
|
|
285
|
+
* The endpoint to use when communicating with the cluster. Kinesis Data Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
|
|
286
|
+
*/
|
|
138
287
|
ClusterEndpoint?: AmazonopensearchserviceClusterEndpoint;
|
|
288
|
+
/**
|
|
289
|
+
* The Amazon OpenSearch Service index name.
|
|
290
|
+
*/
|
|
139
291
|
IndexName?: AmazonopensearchserviceIndexName;
|
|
292
|
+
/**
|
|
293
|
+
* The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
|
|
294
|
+
*/
|
|
140
295
|
TypeName?: AmazonopensearchserviceTypeName;
|
|
296
|
+
/**
|
|
297
|
+
* The Amazon OpenSearch Service index rotation period
|
|
298
|
+
*/
|
|
141
299
|
IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod;
|
|
300
|
+
/**
|
|
301
|
+
* The buffering options.
|
|
302
|
+
*/
|
|
142
303
|
BufferingHints?: AmazonopensearchserviceBufferingHints;
|
|
304
|
+
/**
|
|
305
|
+
* The Amazon OpenSearch Service retry options.
|
|
306
|
+
*/
|
|
143
307
|
RetryOptions?: AmazonopensearchserviceRetryOptions;
|
|
308
|
+
/**
|
|
309
|
+
* The Amazon S3 backup mode.
|
|
310
|
+
*/
|
|
144
311
|
S3BackupMode?: AmazonopensearchserviceS3BackupMode;
|
|
145
312
|
S3DestinationDescription?: S3DestinationDescription;
|
|
146
313
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
@@ -148,13 +315,37 @@ declare namespace Firehose {
|
|
|
148
315
|
VpcConfigurationDescription?: VpcConfigurationDescription;
|
|
149
316
|
}
|
|
150
317
|
export interface AmazonopensearchserviceDestinationUpdate {
|
|
318
|
+
/**
|
|
319
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents.
|
|
320
|
+
*/
|
|
151
321
|
RoleARN?: RoleARN;
|
|
322
|
+
/**
|
|
323
|
+
* The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
|
|
324
|
+
*/
|
|
152
325
|
DomainARN?: AmazonopensearchserviceDomainARN;
|
|
326
|
+
/**
|
|
327
|
+
* The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
|
|
328
|
+
*/
|
|
153
329
|
ClusterEndpoint?: AmazonopensearchserviceClusterEndpoint;
|
|
330
|
+
/**
|
|
331
|
+
* The Amazon OpenSearch Service index name.
|
|
332
|
+
*/
|
|
154
333
|
IndexName?: AmazonopensearchserviceIndexName;
|
|
334
|
+
/**
|
|
335
|
+
* The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Kinesis Data Firehose returns an error during runtime. If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.
|
|
336
|
+
*/
|
|
155
337
|
TypeName?: AmazonopensearchserviceTypeName;
|
|
338
|
+
/**
|
|
339
|
+
* The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
|
|
340
|
+
*/
|
|
156
341
|
IndexRotationPeriod?: AmazonopensearchserviceIndexRotationPeriod;
|
|
342
|
+
/**
|
|
343
|
+
* The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
|
|
344
|
+
*/
|
|
157
345
|
BufferingHints?: AmazonopensearchserviceBufferingHints;
|
|
346
|
+
/**
|
|
347
|
+
* The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
|
348
|
+
*/
|
|
158
349
|
RetryOptions?: AmazonopensearchserviceRetryOptions;
|
|
159
350
|
S3Update?: S3DestinationUpdate;
|
|
160
351
|
ProcessingConfiguration?: ProcessingConfiguration;
|
|
@@ -165,6 +356,9 @@ declare namespace Firehose {
|
|
|
165
356
|
export type AmazonopensearchserviceIndexRotationPeriod = "NoRotation"|"OneHour"|"OneDay"|"OneWeek"|"OneMonth"|string;
|
|
166
357
|
export type AmazonopensearchserviceRetryDurationInSeconds = number;
|
|
167
358
|
export interface AmazonopensearchserviceRetryOptions {
|
|
359
|
+
/**
|
|
360
|
+
* After an initial failure to deliver to Amazon OpenSearch Service, the total amount of time during which Kinesis Data Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
|
|
361
|
+
*/
|
|
168
362
|
DurationInSeconds?: AmazonopensearchserviceRetryDurationInSeconds;
|
|
169
363
|
}
|
|
170
364
|
export type AmazonopensearchserviceS3BackupMode = "FailedDocumentsOnly"|"AllDocuments"|string;
|
|
@@ -217,7 +411,7 @@ declare namespace Firehose {
|
|
|
217
411
|
export type CopyOptions = string;
|
|
218
412
|
export interface CreateDeliveryStreamInput {
|
|
219
413
|
/**
|
|
220
|
-
* The name of the delivery stream. This name must be unique per
|
|
414
|
+
* The name of the delivery stream. This name must be unique per Amazon Web Services account in the same Amazon Web Services Region. If the delivery streams are in different accounts or different Regions, you can have multiple delivery streams with the same name.
|
|
221
415
|
*/
|
|
222
416
|
DeliveryStreamName: DeliveryStreamName;
|
|
223
417
|
/**
|
|
@@ -248,6 +442,9 @@ declare namespace Firehose {
|
|
|
248
442
|
* The destination in Amazon ES. You can specify only one destination.
|
|
249
443
|
*/
|
|
250
444
|
ElasticsearchDestinationConfiguration?: ElasticsearchDestinationConfiguration;
|
|
445
|
+
/**
|
|
446
|
+
* The destination in Amazon OpenSearch Service. You can specify only one destination.
|
|
447
|
+
*/
|
|
251
448
|
AmazonopensearchserviceDestinationConfiguration?: AmazonopensearchserviceDestinationConfiguration;
|
|
252
449
|
/**
|
|
253
450
|
* The destination in Splunk. You can specify only one destination.
|
|
@@ -258,9 +455,13 @@ declare namespace Firehose {
|
|
|
258
455
|
*/
|
|
259
456
|
HttpEndpointDestinationConfiguration?: HttpEndpointDestinationConfiguration;
|
|
260
457
|
/**
|
|
261
|
-
* A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to
|
|
458
|
+
* A set of tags to assign to the delivery stream. A tag is a key-value pair that you can define and assign to Amazon Web Services resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the delivery stream. For more information about tags, see Using Cost Allocation Tags in the Amazon Web Services Billing and Cost Management User Guide. You can specify up to 50 tags when creating a delivery stream.
|
|
262
459
|
*/
|
|
263
460
|
Tags?: TagDeliveryStreamInputTagList;
|
|
461
|
+
/**
|
|
462
|
+
* The destination in the Serverless offering for Amazon OpenSearch Service. You can specify only one destination.
|
|
463
|
+
*/
|
|
464
|
+
AmazonOpenSearchServerlessDestinationConfiguration?: AmazonOpenSearchServerlessDestinationConfiguration;
|
|
264
465
|
}
|
|
265
466
|
export interface CreateDeliveryStreamOutput {
|
|
266
467
|
/**
|
|
@@ -271,7 +472,7 @@ declare namespace Firehose {
|
|
|
271
472
|
export type Data = Buffer|Uint8Array|Blob|string;
|
|
272
473
|
export interface DataFormatConversionConfiguration {
|
|
273
474
|
/**
|
|
274
|
-
* Specifies the
|
|
475
|
+
* Specifies the Amazon Web Services Glue Data Catalog table that contains the column information. This parameter is required if Enabled is set to true.
|
|
275
476
|
*/
|
|
276
477
|
SchemaConfiguration?: SchemaConfiguration;
|
|
277
478
|
/**
|
|
@@ -295,7 +496,7 @@ declare namespace Firehose {
|
|
|
295
496
|
*/
|
|
296
497
|
DeliveryStreamName: DeliveryStreamName;
|
|
297
498
|
/**
|
|
298
|
-
* Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an
|
|
499
|
+
* Set this to true if you want to delete the delivery stream even if Kinesis Data Firehose is unable to retire the grant for the CMK. Kinesis Data Firehose might be unable to retire the grant due to a customer error, such as when the CMK or the grant are in an invalid state. If you force deletion, you can then use the RevokeGrant operation to revoke the grant you gave to Kinesis Data Firehose. If a failure to retire the grant happens due to an Amazon Web Services KMS issue, Kinesis Data Firehose keeps retrying the delete operation. The default value is false.
|
|
299
500
|
*/
|
|
300
501
|
AllowForceDelete?: BooleanObject;
|
|
301
502
|
}
|
|
@@ -309,7 +510,7 @@ declare namespace Firehose {
|
|
|
309
510
|
*/
|
|
310
511
|
DeliveryStreamName: DeliveryStreamName;
|
|
311
512
|
/**
|
|
312
|
-
* The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and
|
|
513
|
+
* The Amazon Resource Name (ARN) of the delivery stream. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
313
514
|
*/
|
|
314
515
|
DeliveryStreamARN: DeliveryStreamARN;
|
|
315
516
|
/**
|
|
@@ -355,11 +556,11 @@ declare namespace Firehose {
|
|
|
355
556
|
}
|
|
356
557
|
export interface DeliveryStreamEncryptionConfiguration {
|
|
357
558
|
/**
|
|
358
|
-
* If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is
|
|
559
|
+
* If KeyType is CUSTOMER_MANAGED_CMK, this field contains the ARN of the customer managed CMK. If KeyType is Amazon Web Services_OWNED_CMK, DeliveryStreamEncryptionConfiguration doesn't contain a value for KeyARN.
|
|
359
560
|
*/
|
|
360
561
|
KeyARN?: AWSKMSKeyARN;
|
|
361
562
|
/**
|
|
362
|
-
* Indicates the type of customer master key (CMK) that is used for encryption. The default setting is
|
|
563
|
+
* Indicates the type of customer master key (CMK) that is used for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs).
|
|
363
564
|
*/
|
|
364
565
|
KeyType?: KeyType;
|
|
365
566
|
/**
|
|
@@ -373,11 +574,11 @@ declare namespace Firehose {
|
|
|
373
574
|
}
|
|
374
575
|
export interface DeliveryStreamEncryptionConfigurationInput {
|
|
375
576
|
/**
|
|
376
|
-
* If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to
|
|
577
|
+
* If you set KeyType to CUSTOMER_MANAGED_CMK, you must specify the Amazon Resource Name (ARN) of the CMK. If you set KeyType to Amazon Web Services_OWNED_CMK, Kinesis Data Firehose uses a service-account CMK.
|
|
377
578
|
*/
|
|
378
579
|
KeyARN?: AWSKMSKeyARN;
|
|
379
580
|
/**
|
|
380
|
-
* Indicates the type of customer master key (CMK) to use for encryption. The default setting is
|
|
581
|
+
* Indicates the type of customer master key (CMK) to use for encryption. The default setting is Amazon Web Services_OWNED_CMK. For more information about CMKs, see Customer Master Keys (CMKs). When you invoke CreateDeliveryStream or StartDeliveryStreamEncryption with KeyType set to CUSTOMER_MANAGED_CMK, Kinesis Data Firehose invokes the Amazon KMS operation CreateGrant to create a grant that allows the Kinesis Data Firehose service to use the customer managed CMK to perform encryption and decryption. Kinesis Data Firehose manages that grant. When you invoke StartDeliveryStreamEncryption to change the CMK for a delivery stream that is encrypted with a customer managed CMK, Kinesis Data Firehose schedules the grant it had on the old CMK for retirement. You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. If a CreateDeliveryStream or StartDeliveryStreamEncryption operation exceeds this limit, Kinesis Data Firehose throws a LimitExceededException. To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see About Symmetric and Asymmetric CMKs in the Amazon Web Services Key Management Service developer guide.
|
|
381
582
|
*/
|
|
382
583
|
KeyType: KeyType;
|
|
383
584
|
}
|
|
@@ -440,6 +641,9 @@ declare namespace Firehose {
|
|
|
440
641
|
* The destination in Amazon ES.
|
|
441
642
|
*/
|
|
442
643
|
ElasticsearchDestinationDescription?: ElasticsearchDestinationDescription;
|
|
644
|
+
/**
|
|
645
|
+
* The destination in Amazon OpenSearch Service.
|
|
646
|
+
*/
|
|
443
647
|
AmazonopensearchserviceDestinationDescription?: AmazonopensearchserviceDestinationDescription;
|
|
444
648
|
/**
|
|
445
649
|
* The destination in Splunk.
|
|
@@ -449,6 +653,10 @@ declare namespace Firehose {
|
|
|
449
653
|
* Describes the specified HTTP endpoint destination.
|
|
450
654
|
*/
|
|
451
655
|
HttpEndpointDestinationDescription?: HttpEndpointDestinationDescription;
|
|
656
|
+
/**
|
|
657
|
+
* The destination in the Serverless offering for Amazon OpenSearch Service.
|
|
658
|
+
*/
|
|
659
|
+
AmazonOpenSearchServerlessDestinationDescription?: AmazonOpenSearchServerlessDestinationDescription;
|
|
452
660
|
}
|
|
453
661
|
export type DestinationDescriptionList = DestinationDescription[];
|
|
454
662
|
export type DestinationId = string;
|
|
@@ -477,11 +685,11 @@ declare namespace Firehose {
|
|
|
477
685
|
export type ElasticsearchClusterEndpoint = string;
|
|
478
686
|
export interface ElasticsearchDestinationConfiguration {
|
|
479
687
|
/**
|
|
480
|
-
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and
|
|
688
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
481
689
|
*/
|
|
482
690
|
RoleARN: RoleARN;
|
|
483
691
|
/**
|
|
484
|
-
* The ARN of the Amazon ES domain. The IAM role must have permissions for
|
|
692
|
+
* The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces. Specify either ClusterEndpoint or DomainARN.
|
|
485
693
|
*/
|
|
486
694
|
DomainARN?: ElasticsearchDomainARN;
|
|
487
695
|
/**
|
|
@@ -509,7 +717,7 @@ declare namespace Firehose {
|
|
|
509
717
|
*/
|
|
510
718
|
RetryOptions?: ElasticsearchRetryOptions;
|
|
511
719
|
/**
|
|
512
|
-
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with
|
|
720
|
+
* Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the Amazon ES Destination. Default value is FailedDocumentsOnly. You can't change this backup mode after you create the delivery stream.
|
|
513
721
|
*/
|
|
514
722
|
S3BackupMode?: ElasticsearchS3BackupMode;
|
|
515
723
|
/**
|
|
@@ -531,11 +739,11 @@ declare namespace Firehose {
|
|
|
531
739
|
}
|
|
532
740
|
export interface ElasticsearchDestinationDescription {
|
|
533
741
|
/**
|
|
534
|
-
* The Amazon Resource Name (ARN) of the
|
|
742
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
535
743
|
*/
|
|
536
744
|
RoleARN?: RoleARN;
|
|
537
745
|
/**
|
|
538
|
-
* The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and
|
|
746
|
+
* The ARN of the Amazon ES domain. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces. Kinesis Data Firehose uses either ClusterEndpoint or DomainARN to send data to Amazon ES.
|
|
539
747
|
*/
|
|
540
748
|
DomainARN?: ElasticsearchDomainARN;
|
|
541
749
|
/**
|
|
@@ -547,7 +755,7 @@ declare namespace Firehose {
|
|
|
547
755
|
*/
|
|
548
756
|
IndexName?: ElasticsearchIndexName;
|
|
549
757
|
/**
|
|
550
|
-
* The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x, there's no value for TypeName.
|
|
758
|
+
* The Elasticsearch type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
|
|
551
759
|
*/
|
|
552
760
|
TypeName?: ElasticsearchTypeName;
|
|
553
761
|
/**
|
|
@@ -585,11 +793,11 @@ declare namespace Firehose {
|
|
|
585
793
|
}
|
|
586
794
|
export interface ElasticsearchDestinationUpdate {
|
|
587
795
|
/**
|
|
588
|
-
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and
|
|
796
|
+
* The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
589
797
|
*/
|
|
590
798
|
RoleARN?: RoleARN;
|
|
591
799
|
/**
|
|
592
|
-
* The ARN of the Amazon ES domain. The IAM role must have permissions for
|
|
800
|
+
* The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces. Specify either ClusterEndpoint or DomainARN.
|
|
593
801
|
*/
|
|
594
802
|
DomainARN?: ElasticsearchDomainARN;
|
|
595
803
|
/**
|
|
@@ -656,11 +864,11 @@ declare namespace Firehose {
|
|
|
656
864
|
export type ErrorOutputPrefix = string;
|
|
657
865
|
export interface ExtendedS3DestinationConfiguration {
|
|
658
866
|
/**
|
|
659
|
-
* The Amazon Resource Name (ARN) of the
|
|
867
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
660
868
|
*/
|
|
661
869
|
RoleARN: RoleARN;
|
|
662
870
|
/**
|
|
663
|
-
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and
|
|
871
|
+
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
664
872
|
*/
|
|
665
873
|
BucketARN: BucketARN;
|
|
666
874
|
/**
|
|
@@ -704,17 +912,17 @@ declare namespace Firehose {
|
|
|
704
912
|
*/
|
|
705
913
|
DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
|
|
706
914
|
/**
|
|
707
|
-
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
|
915
|
+
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
|
708
916
|
*/
|
|
709
917
|
DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
|
|
710
918
|
}
|
|
711
919
|
export interface ExtendedS3DestinationDescription {
|
|
712
920
|
/**
|
|
713
|
-
* The Amazon Resource Name (ARN) of the
|
|
921
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
714
922
|
*/
|
|
715
923
|
RoleARN: RoleARN;
|
|
716
924
|
/**
|
|
717
|
-
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and
|
|
925
|
+
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
718
926
|
*/
|
|
719
927
|
BucketARN: BucketARN;
|
|
720
928
|
/**
|
|
@@ -758,17 +966,17 @@ declare namespace Firehose {
|
|
|
758
966
|
*/
|
|
759
967
|
DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
|
|
760
968
|
/**
|
|
761
|
-
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
|
969
|
+
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
|
762
970
|
*/
|
|
763
971
|
DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
|
|
764
972
|
}
|
|
765
973
|
export interface ExtendedS3DestinationUpdate {
|
|
766
974
|
/**
|
|
767
|
-
* The Amazon Resource Name (ARN) of the
|
|
975
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
768
976
|
*/
|
|
769
977
|
RoleARN?: RoleARN;
|
|
770
978
|
/**
|
|
771
|
-
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and
|
|
979
|
+
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
772
980
|
*/
|
|
773
981
|
BucketARN?: BucketARN;
|
|
774
982
|
/**
|
|
@@ -812,7 +1020,7 @@ declare namespace Firehose {
|
|
|
812
1020
|
*/
|
|
813
1021
|
DataFormatConversionConfiguration?: DataFormatConversionConfiguration;
|
|
814
1022
|
/**
|
|
815
|
-
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
|
1023
|
+
* The configuration of the dynamic partitioning mechanism that creates smaller data sets from the streaming data by partitioning it based on partition keys. Currently, dynamic partitioning is only supported for Amazon S3 destinations.
|
|
816
1024
|
*/
|
|
817
1025
|
DynamicPartitioningConfiguration?: DynamicPartitioningConfiguration;
|
|
818
1026
|
}
|
|
@@ -1002,7 +1210,7 @@ declare namespace Firehose {
|
|
|
1002
1210
|
export type IntervalInSeconds = number;
|
|
1003
1211
|
export interface KMSEncryptionConfig {
|
|
1004
1212
|
/**
|
|
1005
|
-
* The Amazon Resource Name (ARN) of the encryption key. Must belong to the same
|
|
1213
|
+
* The Amazon Resource Name (ARN) of the encryption key. Must belong to the same Amazon Web Services Region as the destination Amazon S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1006
1214
|
*/
|
|
1007
1215
|
AWSKMSKeyARN: AWSKMSKeyARN;
|
|
1008
1216
|
}
|
|
@@ -1014,7 +1222,7 @@ declare namespace Firehose {
|
|
|
1014
1222
|
*/
|
|
1015
1223
|
KinesisStreamARN: KinesisStreamARN;
|
|
1016
1224
|
/**
|
|
1017
|
-
* The ARN of the role that provides access to the source Kinesis data stream. For more information, see
|
|
1225
|
+
* The ARN of the role that provides access to the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.
|
|
1018
1226
|
*/
|
|
1019
1227
|
RoleARN: RoleARN;
|
|
1020
1228
|
}
|
|
@@ -1024,7 +1232,7 @@ declare namespace Firehose {
|
|
|
1024
1232
|
*/
|
|
1025
1233
|
KinesisStreamARN?: KinesisStreamARN;
|
|
1026
1234
|
/**
|
|
1027
|
-
* The ARN of the role used by the source Kinesis data stream. For more information, see
|
|
1235
|
+
* The ARN of the role used by the source Kinesis data stream. For more information, see Amazon Web Services Identity and Access Management (IAM) ARN Format.
|
|
1028
1236
|
*/
|
|
1029
1237
|
RoleARN?: RoleARN;
|
|
1030
1238
|
/**
|
|
@@ -1211,7 +1419,7 @@ declare namespace Firehose {
|
|
|
1211
1419
|
export type ProcessorList = Processor[];
|
|
1212
1420
|
export interface ProcessorParameter {
|
|
1213
1421
|
/**
|
|
1214
|
-
* The name of the parameter.
|
|
1422
|
+
* The name of the parameter. Currently the following default values are supported: 3 for NumberOfRetries and 60 for the BufferIntervalInSeconds. The BufferSizeInMBs ranges between 0.2 MB and up to 3MB. The default buffering hint is 1MB for all destinations, except Splunk. For Splunk, the default buffering hint is 256 KB.
|
|
1215
1423
|
*/
|
|
1216
1424
|
ParameterName: ProcessorParameterName;
|
|
1217
1425
|
/**
|
|
@@ -1293,7 +1501,7 @@ declare namespace Firehose {
|
|
|
1293
1501
|
}
|
|
1294
1502
|
export interface RedshiftDestinationConfiguration {
|
|
1295
1503
|
/**
|
|
1296
|
-
* The Amazon Resource Name (ARN) of the
|
|
1504
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1297
1505
|
*/
|
|
1298
1506
|
RoleARN: RoleARN;
|
|
1299
1507
|
/**
|
|
@@ -1339,7 +1547,7 @@ declare namespace Firehose {
|
|
|
1339
1547
|
}
|
|
1340
1548
|
export interface RedshiftDestinationDescription {
|
|
1341
1549
|
/**
|
|
1342
|
-
* The Amazon Resource Name (ARN) of the
|
|
1550
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1343
1551
|
*/
|
|
1344
1552
|
RoleARN: RoleARN;
|
|
1345
1553
|
/**
|
|
@@ -1381,7 +1589,7 @@ declare namespace Firehose {
|
|
|
1381
1589
|
}
|
|
1382
1590
|
export interface RedshiftDestinationUpdate {
|
|
1383
1591
|
/**
|
|
1384
|
-
* The Amazon Resource Name (ARN) of the
|
|
1592
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1385
1593
|
*/
|
|
1386
1594
|
RoleARN?: RoleARN;
|
|
1387
1595
|
/**
|
|
@@ -1444,11 +1652,11 @@ declare namespace Firehose {
|
|
|
1444
1652
|
export type S3BackupMode = "Disabled"|"Enabled"|string;
|
|
1445
1653
|
export interface S3DestinationConfiguration {
|
|
1446
1654
|
/**
|
|
1447
|
-
* The Amazon Resource Name (ARN) of the
|
|
1655
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1448
1656
|
*/
|
|
1449
1657
|
RoleARN: RoleARN;
|
|
1450
1658
|
/**
|
|
1451
|
-
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and
|
|
1659
|
+
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1452
1660
|
*/
|
|
1453
1661
|
BucketARN: BucketARN;
|
|
1454
1662
|
/**
|
|
@@ -1478,11 +1686,11 @@ declare namespace Firehose {
|
|
|
1478
1686
|
}
|
|
1479
1687
|
export interface S3DestinationDescription {
|
|
1480
1688
|
/**
|
|
1481
|
-
* The Amazon Resource Name (ARN) of the
|
|
1689
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1482
1690
|
*/
|
|
1483
1691
|
RoleARN: RoleARN;
|
|
1484
1692
|
/**
|
|
1485
|
-
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and
|
|
1693
|
+
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1486
1694
|
*/
|
|
1487
1695
|
BucketARN: BucketARN;
|
|
1488
1696
|
/**
|
|
@@ -1512,11 +1720,11 @@ declare namespace Firehose {
|
|
|
1512
1720
|
}
|
|
1513
1721
|
export interface S3DestinationUpdate {
|
|
1514
1722
|
/**
|
|
1515
|
-
* The Amazon Resource Name (ARN) of the
|
|
1723
|
+
* The Amazon Resource Name (ARN) of the Amazon Web Services credentials. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1516
1724
|
*/
|
|
1517
1725
|
RoleARN?: RoleARN;
|
|
1518
1726
|
/**
|
|
1519
|
-
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and
|
|
1727
|
+
* The ARN of the S3 bucket. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
|
|
1520
1728
|
*/
|
|
1521
1729
|
BucketARN?: BucketARN;
|
|
1522
1730
|
/**
|
|
@@ -1546,23 +1754,23 @@ declare namespace Firehose {
|
|
|
1546
1754
|
}
|
|
1547
1755
|
export interface SchemaConfiguration {
|
|
1548
1756
|
/**
|
|
1549
|
-
* The role that Kinesis Data Firehose can use to access
|
|
1757
|
+
* The role that Kinesis Data Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed. If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.
|
|
1550
1758
|
*/
|
|
1551
1759
|
RoleARN?: NonEmptyStringWithoutWhitespace;
|
|
1552
1760
|
/**
|
|
1553
|
-
* The ID of the
|
|
1761
|
+
* The ID of the Amazon Web Services Glue Data Catalog. If you don't supply this, the Amazon Web Services account ID is used by default.
|
|
1554
1762
|
*/
|
|
1555
1763
|
CatalogId?: NonEmptyStringWithoutWhitespace;
|
|
1556
1764
|
/**
|
|
1557
|
-
* Specifies the name of the
|
|
1765
|
+
* Specifies the name of the Amazon Web Services Glue database that contains the schema for the output data. If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.
|
|
1558
1766
|
*/
|
|
1559
1767
|
DatabaseName?: NonEmptyStringWithoutWhitespace;
|
|
1560
1768
|
/**
|
|
1561
|
-
* Specifies the
|
|
1769
|
+
* Specifies the Amazon Web Services Glue table that contains the column information that constitutes your data schema. If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.
|
|
1562
1770
|
*/
|
|
1563
1771
|
TableName?: NonEmptyStringWithoutWhitespace;
|
|
1564
1772
|
/**
|
|
1565
|
-
* If you don't specify an
|
|
1773
|
+
* If you don't specify an Amazon Web Services Region, the default is the current Region.
|
|
1566
1774
|
*/
|
|
1567
1775
|
Region?: NonEmptyStringWithoutWhitespace;
|
|
1568
1776
|
/**
|
|
@@ -1799,6 +2007,9 @@ declare namespace Firehose {
|
|
|
1799
2007
|
* Describes an update for a destination in Amazon ES.
|
|
1800
2008
|
*/
|
|
1801
2009
|
ElasticsearchDestinationUpdate?: ElasticsearchDestinationUpdate;
|
|
2010
|
+
/**
|
|
2011
|
+
* Describes an update for a destination in Amazon OpenSearch Service.
|
|
2012
|
+
*/
|
|
1802
2013
|
AmazonopensearchserviceDestinationUpdate?: AmazonopensearchserviceDestinationUpdate;
|
|
1803
2014
|
/**
|
|
1804
2015
|
* Describes an update for a destination in Splunk.
|
|
@@ -1808,6 +2019,10 @@ declare namespace Firehose {
|
|
|
1808
2019
|
* Describes an update to the specified HTTP endpoint destination.
|
|
1809
2020
|
*/
|
|
1810
2021
|
HttpEndpointDestinationUpdate?: HttpEndpointDestinationUpdate;
|
|
2022
|
+
/**
|
|
2023
|
+
* Describes an update for a destination in the Serverless offering for Amazon OpenSearch Service.
|
|
2024
|
+
*/
|
|
2025
|
+
AmazonOpenSearchServerlessDestinationUpdate?: AmazonOpenSearchServerlessDestinationUpdate;
|
|
1811
2026
|
}
|
|
1812
2027
|
export interface UpdateDestinationOutput {
|
|
1813
2028
|
}
|