Synopsis
Calls the Amazon Kinesis Firehose UpdateDestination API operation.
Syntax
Update-KINFDestination-ElasticsearchDestinationUpdate_ClusterEndpoint <String>-CurrentDeliveryStreamVersionId <String>-DeliveryStreamName <String>-DestinationId <String>-ElasticsearchDestinationUpdate_DomainARN <String>-RetryOptions_DurationInSecond <Int32>-CloudWatchLoggingOptions_Enabled <Boolean>-ProcessingConfiguration_Enabled <Boolean>-ExtendedS3DestinationUpdate <ExtendedS3DestinationUpdate>-ElasticsearchDestinationUpdate_IndexName <String>-ElasticsearchDestinationUpdate_IndexRotationPeriod <ElasticsearchIndexRotationPeriod>-BufferingHints_IntervalInSecond <Int32>-CloudWatchLoggingOptions_LogGroupName <String>-CloudWatchLoggingOptions_LogStreamName <String>-ProcessingConfiguration_Processor <Processor[]>-RedshiftDestinationUpdate <RedshiftDestinationUpdate>-ElasticsearchDestinationUpdate_RoleARN <String>-ElasticsearchDestinationUpdate_S3Update <S3DestinationUpdate>-BufferingHints_SizeInMBs <Int32>-SplunkDestinationUpdate <SplunkDestinationUpdate>-ElasticsearchDestinationUpdate_TypeName <String>-S3DestinationUpdate <S3DestinationUpdate>-Force <SwitchParameter>
Description
Updates the specified destination of the specified delivery stream.
Use this operation to change the destination type (for example, to replace the Amazon S3 destination with Amazon Redshift) or change the parameters associated with a destination (for example, to change the bucket name of the Amazon S3 destination). The update might not occur immediately. The target delivery stream remains active while the configurations are updated, so data writes to the delivery stream can continue during this process. The updated configurations are usually effective within a few minutes.
Switching between Amazon ES and other services is not supported. For an Amazon ES destination, you can only update to another Amazon ES destination.
If the destination type is the same, Kinesis Data Firehose merges the configuration parameters specified with the destination configuration that already exists on the delivery stream. If any of the parameters are not specified in the call, the existing values are retained. For example, in the Amazon S3 destination, if EncryptionConfiguration is not specified, then the existing
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. Parameters
-BufferingHints_IntervalInSecond <Int32>
Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 300 (5 minutes).
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ElasticsearchDestinationUpdate_BufferingHints_IntervalInSeconds |
-BufferingHints_SizeInMBs <Int32>
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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ElasticsearchDestinationUpdate_BufferingHints_SizeInMBs |
-CloudWatchLoggingOptions_Enabled <Boolean>
Enables or disables CloudWatch logging.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ElasticsearchDestinationUpdate_CloudWatchLoggingOptions_Enabled |
-CloudWatchLoggingOptions_LogGroupName <String>
The CloudWatch group name for logging. This value is required if CloudWatch logging is enabled.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ElasticsearchDestinationUpdate_CloudWatchLoggingOptions_LogGroupName |
-CloudWatchLoggingOptions_LogStreamName <String>
The CloudWatch log stream name for logging. This value is required if CloudWatch logging is enabled.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ElasticsearchDestinationUpdate_CloudWatchLoggingOptions_LogStreamName |
-CurrentDeliveryStreamVersionId <String>
Obtain this value from the
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? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DeliveryStreamName <String>
The name of the delivery stream.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-DestinationId <String>
The ID of the destination.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchDestinationUpdate_ClusterEndpoint <String>
The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpoint or the DomainARN field. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchDestinationUpdate_DomainARN <String>
The ARN of the Amazon ES domain. The IAM role must have permissions for
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? | False |
-ElasticsearchDestinationUpdate_IndexName <String>
The Elasticsearch index name.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchDestinationUpdate_IndexRotationPeriod <ElasticsearchIndexRotationPeriod>
The Elasticsearch index rotation period. Index rotation appends a timestamp to
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? | False |
-ElasticsearchDestinationUpdate_RoleARN <String>
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 AWS Service Namespaces.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchDestinationUpdate_S3Update <S3DestinationUpdate>
The Amazon S3 destination.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ElasticsearchDestinationUpdate_TypeName <String>
The Elasticsearch 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. | Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ExtendedS3DestinationUpdate <ExtendedS3DestinationUpdate>
Describes an update for a destination in Amazon S3.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-Force <SwitchParameter>
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProcessingConfiguration_Enabled <Boolean>
Enables or disables data processing.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ElasticsearchDestinationUpdate_ProcessingConfiguration_Enabled |
-ProcessingConfiguration_Processor <Processor[]>
The data processors.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ElasticsearchDestinationUpdate_ProcessingConfiguration_Processors |
-RedshiftDestinationUpdate <RedshiftDestinationUpdate>
Describes an update for a destination in Amazon Redshift.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-RetryOptions_DurationInSecond <Int32>
After an initial failure to deliver to Amazon ES, 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.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ElasticsearchDestinationUpdate_RetryOptions_DurationInSeconds |
-S3DestinationUpdate <S3DestinationUpdate>
[Deprecated] Describes an update for a destination in Amazon S3.This parameter is deprecated.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SplunkDestinationUpdate <SplunkDestinationUpdate>
Describes an update for a destination in Splunk.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Common Credential and Region Parameters
-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AK |
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information,
and optionally a token for session-based credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)
If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials. Note that the encrypted credential file is not supported on all platforms. It will be skipped when searching for profiles on Windows Nano Server, Mac, and Linux platforms.
If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.
As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AWSProfilesLocation, ProfilesLocation |
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing
credential information. The profile is expected to be found in the secure credential
file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also
specify the name of a profile stored in the .ini-format credential file used with
the AWS CLI and other AWS SDKs.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | AWSProfileName, StoredCredentials |
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile.
Contains the network credentials to be supplied during authentication with the
configured identity provider's endpoint. This parameter is not required if the
user's default network identity can or should be used during authentication.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key
if the corresponding session token is supplied to the -SessionToken parameter.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | SecretAccessKey, SK |
-SessionToken <String>
The session token if the access and secret keys are temporary session-based
credentials.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | ST |
-Region <String>
The system name of the AWS region in which the operation should be invoked. For example, us-east-1, eu-west-1 etc.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
| Aliases | RegionToCall |
-EndpointUrl <String>
The endpoint to make the call against.
Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
| Required? | False |
| Position? | Named |
| Accept pipeline input? | False |
Inputs
This cmdlet does not accept pipeline input.
Outputs
None
This cmdlet does not generate any output. The service response (type Amazon.KinesisFirehose.Model.UpdateDestinationResponse) can be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.
Related Links
Supported Version
AWS Tools for PowerShell: 2.x.y.z
