Update Pipe

eventbridgepipes_update_pipe

R Documentation

Update an existing pipe

Description

Update an existing pipe. When you call update_pipe, 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.

Usage

eventbridgepipes_update_pipe(Description, DesiredState, Enrichment,
  EnrichmentParameters, LogConfiguration, Name, RoleArn, SourceParameters,
  Target, TargetParameters)

Arguments

Description

A description of the pipe.

DesiredState

The state the pipe should be in.

Enrichment

The ARN of the enrichment resource.

EnrichmentParameters

The parameters required to set up enrichment on your pipe.

LogConfiguration

The logging configuration settings for the pipe.

Name

[required] The name of the pipe.

RoleArn

[required] The ARN of the role that allows the pipe to send data to the target.

SourceParameters

The parameters required to set up a source for your pipe.

Target

The ARN of the target resource.

TargetParameters

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.

Value

A list with the following syntax:

list(
  Arn = "string",
  CreationTime = as.POSIXct(
    "2015-01-01"
  ),
  CurrentState = "RUNNING"|"STOPPED"|"CREATING"|"UPDATING"|"DELETING"|"STARTING"|"STOPPING"|"CREATE_FAILED"|"UPDATE_FAILED"|"START_FAILED"|"STOP_FAILED"|"DELETE_FAILED"|"CREATE_ROLLBACK_FAILED"|"DELETE_ROLLBACK_FAILED"|"UPDATE_ROLLBACK_FAILED",
  DesiredState = "RUNNING"|"STOPPED",
  LastModifiedTime = as.POSIXct(
    "2015-01-01"
  ),
  Name = "string"
)

Request syntax

svc$update_pipe(
  Description = "string",
  DesiredState = "RUNNING"|"STOPPED",
  Enrichment = "string",
  EnrichmentParameters = list(
    HttpParameters = list(
      HeaderParameters = list(
        "string"
      ),
      PathParameterValues = list(
        "string"
      ),
      QueryStringParameters = list(
        "string"
      )
    ),
    InputTemplate = "string"
  ),
  LogConfiguration = list(
    CloudwatchLogsLogDestination = list(
      LogGroupArn = "string"
    ),
    FirehoseLogDestination = list(
      DeliveryStreamArn = "string"
    ),
    IncludeExecutionData = list(
      "ALL"
    ),
    Level = "OFF"|"ERROR"|"INFO"|"TRACE",
    S3LogDestination = list(
      BucketName = "string",
      BucketOwner = "string",
      OutputFormat = "json"|"plain"|"w3c",
      Prefix = "string"
    )
  ),
  Name = "string",
  RoleArn = "string",
  SourceParameters = list(
    ActiveMQBrokerParameters = list(
      BatchSize = 123,
      Credentials = list(
        BasicAuth = "string"
      ),
      MaximumBatchingWindowInSeconds = 123
    ),
    DynamoDBStreamParameters = list(
      BatchSize = 123,
      DeadLetterConfig = list(
        Arn = "string"
      ),
      MaximumBatchingWindowInSeconds = 123,
      MaximumRecordAgeInSeconds = 123,
      MaximumRetryAttempts = 123,
      OnPartialBatchItemFailure = "AUTOMATIC_BISECT",
      ParallelizationFactor = 123
    ),
    FilterCriteria = list(
      Filters = list(
        list(
          Pattern = "string"
        )
      )
    ),
    KinesisStreamParameters = list(
      BatchSize = 123,
      DeadLetterConfig = list(
        Arn = "string"
      ),
      MaximumBatchingWindowInSeconds = 123,
      MaximumRecordAgeInSeconds = 123,
      MaximumRetryAttempts = 123,
      OnPartialBatchItemFailure = "AUTOMATIC_BISECT",
      ParallelizationFactor = 123
    ),
    ManagedStreamingKafkaParameters = list(
      BatchSize = 123,
      Credentials = list(
        ClientCertificateTlsAuth = "string",
        SaslScram512Auth = "string"
      ),
      MaximumBatchingWindowInSeconds = 123
    ),
    RabbitMQBrokerParameters = list(
      BatchSize = 123,
      Credentials = list(
        BasicAuth = "string"
      ),
      MaximumBatchingWindowInSeconds = 123
    ),
    SelfManagedKafkaParameters = list(
      BatchSize = 123,
      Credentials = list(
        BasicAuth = "string",
        ClientCertificateTlsAuth = "string",
        SaslScram256Auth = "string",
        SaslScram512Auth = "string"
      ),
      MaximumBatchingWindowInSeconds = 123,
      ServerRootCaCertificate = "string",
      Vpc = list(
        SecurityGroup = list(
          "string"
        ),
        Subnets = list(
          "string"
        )
      )
    ),
    SqsQueueParameters = list(
      BatchSize = 123,
      MaximumBatchingWindowInSeconds = 123
    )
  ),
  Target = "string",
  TargetParameters = list(
    BatchJobParameters = list(
      ArrayProperties = list(
        Size = 123
      ),
      ContainerOverrides = list(
        Command = list(
          "string"
        ),
        Environment = list(
          list(
            Name = "string",
            Value = "string"
          )
        ),
        InstanceType = "string",
        ResourceRequirements = list(
          list(
            Type = "GPU"|"MEMORY"|"VCPU",
            Value = "string"
          )
        )
      ),
      DependsOn = list(
        list(
          JobId = "string",
          Type = "N_TO_N"|"SEQUENTIAL"
        )
      ),
      JobDefinition = "string",
      JobName = "string",
      Parameters = list(
        "string"
      ),
      RetryStrategy = list(
        Attempts = 123
      )
    ),
    CloudWatchLogsParameters = list(
      LogStreamName = "string",
      Timestamp = "string"
    ),
    EcsTaskParameters = list(
      CapacityProviderStrategy = list(
        list(
          base = 123,
          capacityProvider = "string",
          weight = 123
        )
      ),
      EnableECSManagedTags = TRUE|FALSE,
      EnableExecuteCommand = TRUE|FALSE,
      Group = "string",
      LaunchType = "EC2"|"FARGATE"|"EXTERNAL",
      NetworkConfiguration = list(
        awsvpcConfiguration = list(
          AssignPublicIp = "ENABLED"|"DISABLED",
          SecurityGroups = list(
            "string"
          ),
          Subnets = list(
            "string"
          )
        )
      ),
      Overrides = list(
        ContainerOverrides = list(
          list(
            Command = list(
              "string"
            ),
            Cpu = 123,
            Environment = list(
              list(
                name = "string",
                value = "string"
              )
            ),
            EnvironmentFiles = list(
              list(
                type = "s3",
                value = "string"
              )
            ),
            Memory = 123,
            MemoryReservation = 123,
            Name = "string",
            ResourceRequirements = list(
              list(
                type = "GPU"|"InferenceAccelerator",
                value = "string"
              )
            )
          )
        ),
        Cpu = "string",
        EphemeralStorage = list(
          sizeInGiB = 123
        ),
        ExecutionRoleArn = "string",
        InferenceAcceleratorOverrides = list(
          list(
            deviceName = "string",
            deviceType = "string"
          )
        ),
        Memory = "string",
        TaskRoleArn = "string"
      ),
      PlacementConstraints = list(
        list(
          expression = "string",
          type = "distinctInstance"|"memberOf"
        )
      ),
      PlacementStrategy = list(
        list(
          field = "string",
          type = "random"|"spread"|"binpack"
        )
      ),
      PlatformVersion = "string",
      PropagateTags = "TASK_DEFINITION",
      ReferenceId = "string",
      Tags = list(
        list(
          Key = "string",
          Value = "string"
        )
      ),
      TaskCount = 123,
      TaskDefinitionArn = "string"
    ),
    EventBridgeEventBusParameters = list(
      DetailType = "string",
      EndpointId = "string",
      Resources = list(
        "string"
      ),
      Source = "string",
      Time = "string"
    ),
    HttpParameters = list(
      HeaderParameters = list(
        "string"
      ),
      PathParameterValues = list(
        "string"
      ),
      QueryStringParameters = list(
        "string"
      )
    ),
    InputTemplate = "string",
    KinesisStreamParameters = list(
      PartitionKey = "string"
    ),
    LambdaFunctionParameters = list(
      InvocationType = "REQUEST_RESPONSE"|"FIRE_AND_FORGET"
    ),
    RedshiftDataParameters = list(
      Database = "string",
      DbUser = "string",
      SecretManagerArn = "string",
      Sqls = list(
        "string"
      ),
      StatementName = "string",
      WithEvent = TRUE|FALSE
    ),
    SageMakerPipelineParameters = list(
      PipelineParameterList = list(
        list(
          Name = "string",
          Value = "string"
        )
      )
    ),
    SqsQueueParameters = list(
      MessageDeduplicationId = "string",
      MessageGroupId = "string"
    ),
    StepFunctionStateMachineParameters = list(
      InvocationType = "REQUEST_RESPONSE"|"FIRE_AND_FORGET"
    )
  )
)