Values.UpdatePipeRequestSourceUpdate an existing pipe. When you call UpdatePipe, EventBridge only the updates fields you have specified in the request; the rest remain unchanged. The exception to this is if you modify any Amazon Web Services-service specific fields in the SourceParameters, EnrichmentParameters, or TargetParameters objects. For example, DynamoDBStreamParameters or EventBridgeEventBusParameters. EventBridge updates the fields in these objects atomically as one and overrides existing values. This is by design, and means that if you don't specify an optional field in one of these Parameters objects, EventBridge sets that field to its system-default value during the update. For more information about pipes, see Amazon EventBridge Pipes in the Amazon EventBridge User Guide.
type nonrec t = {name : PipeName.t;The name of the pipe.
*)description : PipeDescription.t option;A description of the pipe.
*)desiredState : RequestedPipeState.t option;The state the pipe should be in.
*)sourceParameters : UpdatePipeSourceParameters.t option;The parameters required to set up a source for your pipe.
*)enrichment : OptionalArn.t option;The ARN of the enrichment resource.
*)enrichmentParameters : PipeEnrichmentParameters.t option;The parameters required to set up enrichment on your pipe.
*)target : Arn.t option;The ARN of the target resource.
*)targetParameters : PipeTargetParameters.t option;The parameters required to set up a target for your pipe. For more information about pipe target parameters, including how to use dynamic path parameters, see Target parameters in the Amazon EventBridge User Guide.
*)roleArn : RoleArn.t;The ARN of the role that allows the pipe to send data to the target.
*)logConfiguration : PipeLogConfigurationParameters.t option;The logging configuration settings for the pipe.
*)kmsKeyIdentifier : KmsKeyIdentifier.t option;The identifier of the KMS customer managed key for EventBridge to use, if you choose to use a customer managed key to encrypt pipe data. The identifier can be the key Amazon Resource Name (ARN), KeyId, key alias, or key alias ARN. To update a pipe that is using the default Amazon Web Services owned key to use a customer managed key instead, or update a pipe that is using a customer managed key to use a different customer managed key, specify a customer managed key identifier. To update a pipe that is using a customer managed key to use the default Amazon Web Services owned key, specify an empty string. For more information, see Managing keys in the Key Management Service Developer Guide.
*)}val make :
?description:??? ->
?desiredState:??? ->
?sourceParameters:??? ->
?enrichment:??? ->
?enrichmentParameters:??? ->
?target:??? ->
?targetParameters:??? ->
?logConfiguration:??? ->
?kmsKeyIdentifier:??? ->
name:PipeName.t ->
roleArn:RoleArn.t ->
unit ->
tval to_value :
t ->
[> `Structure of
(string
* [> `Enum of string
| `String of PipeName.t
| `Structure of
(string
* [> `Enum of string
| `List of [> `Enum of string ] list
| `String of InputTemplate.t
| `Structure of
(string
* [> `Boolean of Boolean.t
| `Enum of string
| `Integer of LimitMax10000.t
| `List of
[> `String of PathParameter.t
| `Structure of
(string
* [> `Enum of string
| `Integer of CapacityProviderStrategyItemWeight.t
| `List of
[> `Structure of
(string
* [> `Enum of string
| `String of MeasureValue.t ])
list ]
list
| `String of EventPattern.t ])
list ]
list
| `Map of
([> `String of HeaderKey.t ]
* [> `String of HeaderValue.t ])
list
| `String of SecretManagerArn.t
| `Structure of
(string
* [> `Integer of BatchArraySize.t
| `List of
[> `String of SubnetId.t
| `Structure of
(string
* [> `Enum of string
| `Integer of Integer.t
| `List of
[> `String of String_.t
| `Structure of
(string
* [> `Enum of string
| `String of String_.t ])
list ]
list
| `String of String_.t ])
list ]
list
| `String of Arn.t
| `Structure of
(string
* [> `Enum of string
| `Integer of EphemeralStorageSize.t
| `List of [> `String of Subnet.t ] list ])
list ])
list ])
list ])
list ])
list ]