Update Pipeline
opensearchingestion_update_pipeline | R Documentation |
Updates an OpenSearch Ingestion pipeline¶
Description¶
Updates an OpenSearch Ingestion pipeline. For more information, see Updating Amazon OpenSearch Ingestion pipelines.
Usage¶
opensearchingestion_update_pipeline(PipelineName, MinUnits, MaxUnits,
PipelineConfigurationBody, LogPublishingOptions, BufferOptions,
EncryptionAtRestOptions)
Arguments¶
PipelineName
[required] The name of the pipeline to update.
MinUnits
The minimum pipeline capacity, in Ingestion Compute Units (ICUs).
MaxUnits
The maximum pipeline capacity, in Ingestion Compute Units (ICUs)
PipelineConfigurationBody
The pipeline configuration in YAML format. The command accepts the pipeline configuration as a string or within a .yaml file. If you provide the configuration as a string, each new line must be escaped with
\\n
.LogPublishingOptions
Key-value pairs to configure log publishing.
BufferOptions
Key-value pairs to configure persistent buffering for the pipeline.
EncryptionAtRestOptions
Key-value pairs to configure encryption for data that is written to a persistent buffer.
Value¶
A list with the following syntax:
list(
Pipeline = list(
PipelineName = "string",
PipelineArn = "string",
MinUnits = 123,
MaxUnits = 123,
Status = "CREATING"|"ACTIVE"|"UPDATING"|"DELETING"|"CREATE_FAILED"|"UPDATE_FAILED"|"STARTING"|"START_FAILED"|"STOPPING"|"STOPPED",
StatusReason = list(
Description = "string"
),
PipelineConfigurationBody = "string",
CreatedAt = as.POSIXct(
"2015-01-01"
),
LastUpdatedAt = as.POSIXct(
"2015-01-01"
),
IngestEndpointUrls = list(
"string"
),
LogPublishingOptions = list(
IsLoggingEnabled = TRUE|FALSE,
CloudWatchLogDestination = list(
LogGroup = "string"
)
),
VpcEndpoints = list(
list(
VpcEndpointId = "string",
VpcId = "string",
VpcOptions = list(
SubnetIds = list(
"string"
),
SecurityGroupIds = list(
"string"
),
VpcAttachmentOptions = list(
AttachToVpc = TRUE|FALSE,
CidrBlock = "string"
),
VpcEndpointManagement = "CUSTOMER"|"SERVICE"
)
)
),
BufferOptions = list(
PersistentBufferEnabled = TRUE|FALSE
),
EncryptionAtRestOptions = list(
KmsKeyArn = "string"
),
VpcEndpointService = "string",
ServiceVpcEndpoints = list(
list(
ServiceName = "OPENSEARCH_SERVERLESS",
VpcEndpointId = "string"
)
),
Destinations = list(
list(
ServiceName = "string",
Endpoint = "string"
)
),
Tags = list(
list(
Key = "string",
Value = "string"
)
)
)
)
Request syntax¶
svc$update_pipeline(
PipelineName = "string",
MinUnits = 123,
MaxUnits = 123,
PipelineConfigurationBody = "string",
LogPublishingOptions = list(
IsLoggingEnabled = TRUE|FALSE,
CloudWatchLogDestination = list(
LogGroup = "string"
)
),
BufferOptions = list(
PersistentBufferEnabled = TRUE|FALSE
),
EncryptionAtRestOptions = list(
KmsKeyArn = "string"
)
)