AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.
Update-KINFDestination-HttpEndpointDestinationUpdate_EndpointConfiguration_AccessKey <String>-AmazonopensearchserviceDestinationUpdate_ClusterEndpoint <String>-ElasticsearchDestinationUpdate_ClusterEndpoint <String>-HttpEndpointDestinationUpdate_RequestConfiguration_CommonAttributes <HttpEndpointCommonAttribute[]>-HttpEndpointDestinationUpdate_RequestConfiguration_ContentEncoding <ContentEncoding>-CurrentDeliveryStreamVersionId <String>-DeliveryStreamName <String>-DestinationId <String>-AmazonopensearchserviceDestinationUpdate_DomainARN <String>-ElasticsearchDestinationUpdate_DomainARN <String>-AmazonopensearchserviceDestinationUpdate_RetryOptions_DurationInSeconds <Int32>-RetryOptions_DurationInSecond <Int32>-HttpEndpointDestinationUpdate_RetryOptions_DurationInSeconds <Int32>-AmazonopensearchserviceDestinationUpdate_CloudWatchLoggingOptions_Enabled <Boolean>-AmazonopensearchserviceDestinationUpdate_ProcessingConfiguration_Enabled <Boolean>-CloudWatchLoggingOptions_Enabled <Boolean>-ProcessingConfiguration_Enabled <Boolean>-HttpEndpointDestinationUpdate_CloudWatchLoggingOptions_Enabled <Boolean>-HttpEndpointDestinationUpdate_ProcessingConfiguration_Enabled <Boolean>-ExtendedS3DestinationUpdate <ExtendedS3DestinationUpdate>-AmazonopensearchserviceDestinationUpdate_IndexName <String>-ElasticsearchDestinationUpdate_IndexName <String>-AmazonopensearchserviceDestinationUpdate_IndexRotationPeriod <AmazonopensearchserviceIndexRotationPeriod>-ElasticsearchDestinationUpdate_IndexRotationPeriod <ElasticsearchIndexRotationPeriod>-AmazonopensearchserviceDestinationUpdate_BufferingHints_IntervalInSeconds <Int32>-BufferingHints_IntervalInSecond <Int32>-HttpEndpointDestinationUpdate_BufferingHints_IntervalInSeconds <Int32>-AmazonopensearchserviceDestinationUpdate_CloudWatchLoggingOptions_LogGroupName <String>-CloudWatchLoggingOptions_LogGroupName <String>-HttpEndpointDestinationUpdate_CloudWatchLoggingOptions_LogGroupName <String>-AmazonopensearchserviceDestinationUpdate_CloudWatchLoggingOptions_LogStreamName <String>-CloudWatchLoggingOptions_LogStreamName <String>-HttpEndpointDestinationUpdate_CloudWatchLoggingOptions_LogStreamName <String>-EndpointConfiguration_Name <String>-AmazonopensearchserviceDestinationUpdate_ProcessingConfiguration_Processors <Processor[]>-ProcessingConfiguration_Processor <Processor[]>-HttpEndpointDestinationUpdate_ProcessingConfiguration_Processors <Processor[]>-RedshiftDestinationUpdate <RedshiftDestinationUpdate>-AmazonopensearchserviceDestinationUpdate_RoleARN <String>-ElasticsearchDestinationUpdate_RoleARN <String>-HttpEndpointDestinationUpdate_RoleARN <String>-HttpEndpointDestinationUpdate_S3BackupMode <HttpEndpointS3BackupMode>-AmazonopensearchserviceDestinationUpdate_S3Update <S3DestinationUpdate>-ElasticsearchDestinationUpdate_S3Update <S3DestinationUpdate>-HttpEndpointDestinationUpdate_S3Update <S3DestinationUpdate>-AmazonopensearchserviceDestinationUpdate_BufferingHints_SizeInMBs <Int32>-BufferingHints_SizeInMBs <Int32>-HttpEndpointDestinationUpdate_BufferingHints_SizeInMBs <Int32>-SplunkDestinationUpdate <SplunkDestinationUpdate>-AmazonopensearchserviceDestinationUpdate_TypeName <String>-ElasticsearchDestinationUpdate_TypeName <String>-HttpEndpointDestinationUpdate_EndpointConfiguration_Url <String>-S3DestinationUpdate <S3DestinationUpdate>-Select <String>-Force <SwitchParameter>
EncryptionConfiguration
is maintained on the destination.
If the destination type is not the same, for example, changing the destination from Amazon S3 to Amazon Redshift, Kinesis Data Firehose does not merge any parameters. In this case, all parameters must be specified.
Kinesis Data Firehose uses CurrentDeliveryStreamVersionId
to avoid race conditions and conflicting merges. This is a required field, and the service updates the configuration only if the existing configuration has a version ID that matches. After the update is applied successfully, the version ID is updated, and can be retrieved using DescribeDeliveryStream. Use the new version ID to set CurrentDeliveryStreamVersionId
in the next call. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ElasticsearchDestinationUpdate_BufferingHints_IntervalInSeconds |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ElasticsearchDestinationUpdate_BufferingHints_SizeInMBs |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ElasticsearchDestinationUpdate_CloudWatchLoggingOptions_Enabled |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ElasticsearchDestinationUpdate_CloudWatchLoggingOptions_LogGroupName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ElasticsearchDestinationUpdate_CloudWatchLoggingOptions_LogStreamName |
VersionId
result of DeliveryStreamDescription. This value is required, and helps the service perform conditional operations. For example, if there is an interleaving update and this value is null, then the update destination fails. After the update is successful, the VersionId
value is updated. The service then performs a merge of the old configuration with the new configuration. Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | True |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
ClusterEndpoint
or the DomainARN
field. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
DescribeElasticsearchDomain
, DescribeElasticsearchDomains
, and DescribeElasticsearchDomainConfig
after assuming the IAM role specified in RoleARN
. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.Specify either ClusterEndpoint
or DomainARN
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
IndexName
to facilitate the expiration of old data. For more information, see Index Rotation for the Amazon ES Destination. Default value is OneDay
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
TypeName
. Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | HttpEndpointDestinationUpdate_EndpointConfiguration_Name |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
AllData
) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly
). Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ElasticsearchDestinationUpdate_ProcessingConfiguration_Enabled |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ElasticsearchDestinationUpdate_ProcessingConfiguration_Processors |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ElasticsearchDestinationUpdate_RetryOptions_DurationInSeconds |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AK |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByValue, ByPropertyName) |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | AWSProfilesLocation, ProfilesLocation |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | StoredCredentials, AWSProfileName |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | RegionToCall |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | SK, SecretAccessKey |
Required? | False |
Position? | Named |
Accept pipeline input? | True (ByPropertyName) |
Aliases | ST |
AWS Tools for PowerShell: 2.x.y.z