We recommend new projects start with resources from the AWS provider.
aws-native.pipes.getPipe
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Definition of AWS::Pipes::Pipe Resource Type
Using getPipe
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getPipe(args: GetPipeArgs, opts?: InvokeOptions): Promise<GetPipeResult>
function getPipeOutput(args: GetPipeOutputArgs, opts?: InvokeOptions): Output<GetPipeResult>
def get_pipe(name: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetPipeResult
def get_pipe_output(name: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetPipeResult]
func LookupPipe(ctx *Context, args *LookupPipeArgs, opts ...InvokeOption) (*LookupPipeResult, error)
func LookupPipeOutput(ctx *Context, args *LookupPipeOutputArgs, opts ...InvokeOption) LookupPipeResultOutput
> Note: This function is named LookupPipe
in the Go SDK.
public static class GetPipe
{
public static Task<GetPipeResult> InvokeAsync(GetPipeArgs args, InvokeOptions? opts = null)
public static Output<GetPipeResult> Invoke(GetPipeInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetPipeResult> getPipe(GetPipeArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
fn::invoke:
function: aws-native:pipes:getPipe
arguments:
# arguments dictionary
The following arguments are supported:
- Name string
- The name of the pipe.
- Name string
- The name of the pipe.
- name String
- The name of the pipe.
- name string
- The name of the pipe.
- name str
- The name of the pipe.
- name String
- The name of the pipe.
getPipe Result
The following output properties are available:
- Arn string
- The ARN of the pipe.
- Creation
Time string - The time the pipe was created.
- Current
State Pulumi.Aws Native. Pipes. Pipe State - The state the pipe is in.
- Description string
- A description of the pipe.
- Desired
State Pulumi.Aws Native. Pipes. Pipe Requested Pipe State - The state the pipe should be in.
- Enrichment string
- The ARN of the enrichment resource.
- Enrichment
Parameters Pulumi.Aws Native. Pipes. Outputs. Pipe Enrichment Parameters - The parameters required to set up enrichment on your pipe.
- Kms
Key stringIdentifier The identifier of the AWS 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 AWS 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 AWS owned key , specify an empty string.
For more information, see Managing keys in the AWS Key Management Service Developer Guide .
- Last
Modified stringTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- Log
Configuration Pulumi.Aws Native. Pipes. Outputs. Pipe Log Configuration - The logging configuration settings for the pipe.
- Role
Arn string - The ARN of the role that allows the pipe to send data to the target.
- State
Reason string - The reason the pipe is in its current state.
- Dictionary<string, string>
- The list of key-value pairs to associate with the pipe.
- Target string
- The ARN of the target resource.
- Arn string
- The ARN of the pipe.
- Creation
Time string - The time the pipe was created.
- Current
State PipeState Enum - The state the pipe is in.
- Description string
- A description of the pipe.
- Desired
State PipeRequested Pipe State - The state the pipe should be in.
- Enrichment string
- The ARN of the enrichment resource.
- Enrichment
Parameters PipeEnrichment Parameters - The parameters required to set up enrichment on your pipe.
- Kms
Key stringIdentifier The identifier of the AWS 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 AWS 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 AWS owned key , specify an empty string.
For more information, see Managing keys in the AWS Key Management Service Developer Guide .
- Last
Modified stringTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- Log
Configuration PipeLog Configuration - The logging configuration settings for the pipe.
- Role
Arn string - The ARN of the role that allows the pipe to send data to the target.
- State
Reason string - The reason the pipe is in its current state.
- map[string]string
- The list of key-value pairs to associate with the pipe.
- Target string
- The ARN of the target resource.
- arn String
- The ARN of the pipe.
- creation
Time String - The time the pipe was created.
- current
State PipeState - The state the pipe is in.
- description String
- A description of the pipe.
- desired
State PipeRequested Pipe State - The state the pipe should be in.
- enrichment String
- The ARN of the enrichment resource.
- enrichment
Parameters PipeEnrichment Parameters - The parameters required to set up enrichment on your pipe.
- kms
Key StringIdentifier The identifier of the AWS 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 AWS 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 AWS owned key , specify an empty string.
For more information, see Managing keys in the AWS Key Management Service Developer Guide .
- last
Modified StringTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- log
Configuration PipeLog Configuration - The logging configuration settings for the pipe.
- role
Arn String - The ARN of the role that allows the pipe to send data to the target.
- state
Reason String - The reason the pipe is in its current state.
- Map<String,String>
- The list of key-value pairs to associate with the pipe.
- target String
- The ARN of the target resource.
- arn string
- The ARN of the pipe.
- creation
Time string - The time the pipe was created.
- current
State PipeState - The state the pipe is in.
- description string
- A description of the pipe.
- desired
State PipeRequested Pipe State - The state the pipe should be in.
- enrichment string
- The ARN of the enrichment resource.
- enrichment
Parameters PipeEnrichment Parameters - The parameters required to set up enrichment on your pipe.
- kms
Key stringIdentifier The identifier of the AWS 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 AWS 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 AWS owned key , specify an empty string.
For more information, see Managing keys in the AWS Key Management Service Developer Guide .
- last
Modified stringTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- log
Configuration PipeLog Configuration - The logging configuration settings for the pipe.
- role
Arn string - The ARN of the role that allows the pipe to send data to the target.
- state
Reason string - The reason the pipe is in its current state.
- {[key: string]: string}
- The list of key-value pairs to associate with the pipe.
- target string
- The ARN of the target resource.
- arn str
- The ARN of the pipe.
- creation_
time str - The time the pipe was created.
- current_
state PipeState - The state the pipe is in.
- description str
- A description of the pipe.
- desired_
state PipeRequested Pipe State - The state the pipe should be in.
- enrichment str
- The ARN of the enrichment resource.
- enrichment_
parameters PipeEnrichment Parameters - The parameters required to set up enrichment on your pipe.
- kms_
key_ stridentifier The identifier of the AWS 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 AWS 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 AWS owned key , specify an empty string.
For more information, see Managing keys in the AWS Key Management Service Developer Guide .
- last_
modified_ strtime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- log_
configuration PipeLog Configuration - The logging configuration settings for the pipe.
- role_
arn str - The ARN of the role that allows the pipe to send data to the target.
- state_
reason str - The reason the pipe is in its current state.
- Mapping[str, str]
- The list of key-value pairs to associate with the pipe.
- target str
- The ARN of the target resource.
- arn String
- The ARN of the pipe.
- creation
Time String - The time the pipe was created.
- current
State "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" - The state the pipe is in.
- description String
- A description of the pipe.
- desired
State "RUNNING" | "STOPPED" - The state the pipe should be in.
- enrichment String
- The ARN of the enrichment resource.
- enrichment
Parameters Property Map - The parameters required to set up enrichment on your pipe.
- kms
Key StringIdentifier The identifier of the AWS 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 AWS 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 AWS owned key , specify an empty string.
For more information, see Managing keys in the AWS Key Management Service Developer Guide .
- last
Modified StringTime - When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
- log
Configuration Property Map - The logging configuration settings for the pipe.
- role
Arn String - The ARN of the role that allows the pipe to send data to the target.
- state
Reason String - The reason the pipe is in its current state.
- Map<String>
- The list of key-value pairs to associate with the pipe.
- target String
- The ARN of the target resource.
Supporting Types
PipeCloudwatchLogsLogDestination
- Log
Group stringArn - The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
- Log
Group stringArn - The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
- log
Group StringArn - The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
- log
Group stringArn - The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
- log_
group_ strarn - The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
- log
Group StringArn - The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
PipeEnrichmentHttpParameters
- Header
Parameters Dictionary<string, string> - The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- Path
Parameter List<string>Values - The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
- Query
String Dictionary<string, string>Parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- Header
Parameters map[string]string - The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- Path
Parameter []stringValues - The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
- Query
String map[string]stringParameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- header
Parameters Map<String,String> - The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- path
Parameter List<String>Values - The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
- query
String Map<String,String>Parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- header
Parameters {[key: string]: string} - The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- path
Parameter string[]Values - The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
- query
String {[key: string]: string}Parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- header_
parameters Mapping[str, str] - The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- path_
parameter_ Sequence[str]values - The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
- query_
string_ Mapping[str, str]parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- header
Parameters Map<String> - The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
- path
Parameter List<String>Values - The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
- query
String Map<String>Parameters - The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
PipeEnrichmentParameters
- Http
Parameters Pulumi.Aws Native. Pipes. Inputs. Pipe Enrichment Http Parameters Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
- Input
Template string Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
To remove an input template, specify an empty string.
- Http
Parameters PipeEnrichment Http Parameters Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
- Input
Template string Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
To remove an input template, specify an empty string.
- http
Parameters PipeEnrichment Http Parameters Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
- input
Template String Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
To remove an input template, specify an empty string.
- http
Parameters PipeEnrichment Http Parameters Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
- input
Template string Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
To remove an input template, specify an empty string.
- http_
parameters PipeEnrichment Http Parameters Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
- input_
template str Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
To remove an input template, specify an empty string.
- http
Parameters Property Map Contains the HTTP parameters to use when the target is a API Gateway REST endpoint or EventBridge ApiDestination.
If you specify an API Gateway REST API or EventBridge ApiDestination as a target, you can use this parameter to specify headers, path parameters, and query string keys/values as part of your target invoking request. If you're using ApiDestinations, the corresponding Connection can also have these values configured. In case of any conflicting keys, values from the Connection take precedence.
- input
Template String Valid JSON text passed to the enrichment. In this case, nothing from the event itself is passed to the enrichment. For more information, see The JavaScript Object Notation (JSON) Data Interchange Format .
To remove an input template, specify an empty string.
PipeFirehoseLogDestination
- Delivery
Stream stringArn - The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
- Delivery
Stream stringArn - The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
- delivery
Stream StringArn - The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
- delivery
Stream stringArn - The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
- delivery_
stream_ strarn - The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
- delivery
Stream StringArn - The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
PipeIncludeExecutionDataOption
PipeLogConfiguration
- Cloudwatch
Logs Pulumi.Log Destination Aws Native. Pipes. Inputs. Pipe Cloudwatch Logs Log Destination - The logging configuration settings for the pipe.
- Firehose
Log Pulumi.Destination Aws Native. Pipes. Inputs. Pipe Firehose Log Destination - The Amazon Data Firehose logging configuration settings for the pipe.
- Include
Execution List<Pulumi.Data Aws Native. Pipes. Pipe Include Execution Data Option> Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe.This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide .
Allowed values:
ALL
- Level
Pulumi.
Aws Native. Pipes. Pipe Log Level - The level of logging detail to include. This applies to all log destinations for the pipe.
- S3Log
Destination Pulumi.Aws Native. Pipes. Inputs. Pipe S3Log Destination - The Amazon S3 logging configuration settings for the pipe.
- Cloudwatch
Logs PipeLog Destination Cloudwatch Logs Log Destination - The logging configuration settings for the pipe.
- Firehose
Log PipeDestination Firehose Log Destination - The Amazon Data Firehose logging configuration settings for the pipe.
- Include
Execution []PipeData Include Execution Data Option Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe.This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide .
Allowed values:
ALL
- Level
Pipe
Log Level - The level of logging detail to include. This applies to all log destinations for the pipe.
- S3Log
Destination PipeS3Log Destination - The Amazon S3 logging configuration settings for the pipe.
- cloudwatch
Logs PipeLog Destination Cloudwatch Logs Log Destination - The logging configuration settings for the pipe.
- firehose
Log PipeDestination Firehose Log Destination - The Amazon Data Firehose logging configuration settings for the pipe.
- include
Execution List<PipeData Include Execution Data Option> Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe.This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide .
Allowed values:
ALL
- level
Pipe
Log Level - The level of logging detail to include. This applies to all log destinations for the pipe.
- s3Log
Destination PipeS3Log Destination - The Amazon S3 logging configuration settings for the pipe.
- cloudwatch
Logs PipeLog Destination Cloudwatch Logs Log Destination - The logging configuration settings for the pipe.
- firehose
Log PipeDestination Firehose Log Destination - The Amazon Data Firehose logging configuration settings for the pipe.
- include
Execution PipeData Include Execution Data Option[] Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe.This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide .
Allowed values:
ALL
- level
Pipe
Log Level - The level of logging detail to include. This applies to all log destinations for the pipe.
- s3Log
Destination PipeS3Log Destination - The Amazon S3 logging configuration settings for the pipe.
- cloudwatch_
logs_ Pipelog_ destination Cloudwatch Logs Log Destination - The logging configuration settings for the pipe.
- firehose_
log_ Pipedestination Firehose Log Destination - The Amazon Data Firehose logging configuration settings for the pipe.
- include_
execution_ Sequence[Pipedata Include Execution Data Option] Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe.This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide .
Allowed values:
ALL
- level
Pipe
Log Level - The level of logging detail to include. This applies to all log destinations for the pipe.
- s3_
log_ Pipedestination S3Log Destination - The Amazon S3 logging configuration settings for the pipe.
- cloudwatch
Logs Property MapLog Destination - The logging configuration settings for the pipe.
- firehose
Log Property MapDestination - The Amazon Data Firehose logging configuration settings for the pipe.
- include
Execution List<"ALL">Data Whether the execution data (specifically, the
payload
,awsRequest
, andawsResponse
fields) is included in the log messages for this pipe.This applies to all log destinations for the pipe.
For more information, see Including execution data in logs in the Amazon EventBridge User Guide .
Allowed values:
ALL
- level "OFF" | "ERROR" | "INFO" | "TRACE"
- The level of logging detail to include. This applies to all log destinations for the pipe.
- s3Log
Destination Property Map - The Amazon S3 logging configuration settings for the pipe.
PipeLogLevel
PipeRequestedPipeState
PipeS3LogDestination
- Bucket
Name string - The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- Bucket
Owner string - The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- Output
Format Pulumi.Aws Native. Pipes. Pipe S3Output Format The format EventBridge uses for the log records.
EventBridge currently only supports
json
formatting.- Prefix string
The prefix text with which to begin Amazon S3 log object names.
For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
- Bucket
Name string - The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- Bucket
Owner string - The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- Output
Format PipeS3Output Format The format EventBridge uses for the log records.
EventBridge currently only supports
json
formatting.- Prefix string
The prefix text with which to begin Amazon S3 log object names.
For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
- bucket
Name String - The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- bucket
Owner String - The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- output
Format PipeS3Output Format The format EventBridge uses for the log records.
EventBridge currently only supports
json
formatting.- prefix String
The prefix text with which to begin Amazon S3 log object names.
For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
- bucket
Name string - The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- bucket
Owner string - The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- output
Format PipeS3Output Format The format EventBridge uses for the log records.
EventBridge currently only supports
json
formatting.- prefix string
The prefix text with which to begin Amazon S3 log object names.
For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
- bucket_
name str - The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- bucket_
owner str - The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- output_
format PipeS3Output Format The format EventBridge uses for the log records.
EventBridge currently only supports
json
formatting.- prefix str
The prefix text with which to begin Amazon S3 log object names.
For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
- bucket
Name String - The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- bucket
Owner String - The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
- output
Format "json" | "plain" | "w3c" The format EventBridge uses for the log records.
EventBridge currently only supports
json
formatting.- prefix String
The prefix text with which to begin Amazon S3 log object names.
For more information, see Organizing objects using prefixes in the Amazon Simple Storage Service User Guide .
PipeS3OutputFormat
PipeState
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.