Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. pipes
  5. getPipe

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.pipes.getPipe

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    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.
    CreationTime string
    The time the pipe was created.
    CurrentState Pulumi.AwsNative.Pipes.PipeState
    The state the pipe is in.
    Description string
    A description of the pipe.
    DesiredState Pulumi.AwsNative.Pipes.PipeRequestedPipeState
    The state the pipe should be in.
    Enrichment string
    The ARN of the enrichment resource.
    EnrichmentParameters Pulumi.AwsNative.Pipes.Outputs.PipeEnrichmentParameters
    The parameters required to set up enrichment on your pipe.
    LastModifiedTime string
    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    LogConfiguration Pulumi.AwsNative.Pipes.Outputs.PipeLogConfiguration
    The logging configuration settings for the pipe.
    RoleArn string
    The ARN of the role that allows the pipe to send data to the target.
    StateReason string
    The reason the pipe is in its current state.
    Tags 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.
    CreationTime string
    The time the pipe was created.
    CurrentState PipeStateEnum
    The state the pipe is in.
    Description string
    A description of the pipe.
    DesiredState PipeRequestedPipeState
    The state the pipe should be in.
    Enrichment string
    The ARN of the enrichment resource.
    EnrichmentParameters PipeEnrichmentParameters
    The parameters required to set up enrichment on your pipe.
    LastModifiedTime string
    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    LogConfiguration PipeLogConfiguration
    The logging configuration settings for the pipe.
    RoleArn string
    The ARN of the role that allows the pipe to send data to the target.
    StateReason string
    The reason the pipe is in its current state.
    Tags 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.
    creationTime String
    The time the pipe was created.
    currentState PipeState
    The state the pipe is in.
    description String
    A description of the pipe.
    desiredState PipeRequestedPipeState
    The state the pipe should be in.
    enrichment String
    The ARN of the enrichment resource.
    enrichmentParameters PipeEnrichmentParameters
    The parameters required to set up enrichment on your pipe.
    lastModifiedTime String
    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    logConfiguration PipeLogConfiguration
    The logging configuration settings for the pipe.
    roleArn String
    The ARN of the role that allows the pipe to send data to the target.
    stateReason String
    The reason the pipe is in its current state.
    tags 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.
    creationTime string
    The time the pipe was created.
    currentState PipeState
    The state the pipe is in.
    description string
    A description of the pipe.
    desiredState PipeRequestedPipeState
    The state the pipe should be in.
    enrichment string
    The ARN of the enrichment resource.
    enrichmentParameters PipeEnrichmentParameters
    The parameters required to set up enrichment on your pipe.
    lastModifiedTime string
    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    logConfiguration PipeLogConfiguration
    The logging configuration settings for the pipe.
    roleArn string
    The ARN of the role that allows the pipe to send data to the target.
    stateReason string
    The reason the pipe is in its current state.
    tags {[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 PipeRequestedPipeState
    The state the pipe should be in.
    enrichment str
    The ARN of the enrichment resource.
    enrichment_parameters PipeEnrichmentParameters
    The parameters required to set up enrichment on your pipe.
    last_modified_time str
    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    log_configuration PipeLogConfiguration
    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.
    tags 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.
    creationTime String
    The time the pipe was created.
    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"
    The state the pipe is in.
    description String
    A description of the pipe.
    desiredState "RUNNING" | "STOPPED"
    The state the pipe should be in.
    enrichment String
    The ARN of the enrichment resource.
    enrichmentParameters Property Map
    The parameters required to set up enrichment on your pipe.
    lastModifiedTime String
    When the pipe was last updated, in ISO-8601 format (YYYY-MM-DDThh:mm:ss.sTZD).
    logConfiguration Property Map
    The logging configuration settings for the pipe.
    roleArn String
    The ARN of the role that allows the pipe to send data to the target.
    stateReason String
    The reason the pipe is in its current state.
    tags Map<String>
    The list of key-value pairs to associate with the pipe.
    target String
    The ARN of the target resource.

    Supporting Types

    PipeCloudwatchLogsLogDestination

    LogGroupArn string
    The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
    LogGroupArn string
    The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
    logGroupArn String
    The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
    logGroupArn string
    The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
    log_group_arn str
    The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.
    logGroupArn String
    The AWS Resource Name (ARN) for the CloudWatch log group to which EventBridge sends the log records.

    PipeEnrichmentHttpParameters

    HeaderParameters Dictionary<string, string>
    The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    PathParameterValues List<string>
    The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
    QueryStringParameters Dictionary<string, string>
    The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    HeaderParameters map[string]string
    The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    PathParameterValues []string
    The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
    QueryStringParameters map[string]string
    The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    headerParameters Map<String,String>
    The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    pathParameterValues List<String>
    The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
    queryStringParameters Map<String,String>
    The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    headerParameters {[key: string]: string}
    The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    pathParameterValues string[]
    The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
    queryStringParameters {[key: string]: string}
    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_values Sequence[str]
    The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
    query_string_parameters Mapping[str, str]
    The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    headerParameters Map<String>
    The headers that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.
    pathParameterValues List<String>
    The path parameter values to be used to populate API Gateway REST API or EventBridge ApiDestination path wildcards ("*").
    queryStringParameters Map<String>
    The query string keys/values that need to be sent as part of request invoking the API Gateway REST API or EventBridge ApiDestination.

    PipeEnrichmentParameters

    HttpParameters Pulumi.AwsNative.Pipes.Inputs.PipeEnrichmentHttpParameters

    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.

    InputTemplate 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.

    HttpParameters PipeEnrichmentHttpParameters

    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.

    InputTemplate 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.

    httpParameters PipeEnrichmentHttpParameters

    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.

    inputTemplate 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.

    httpParameters PipeEnrichmentHttpParameters

    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.

    inputTemplate 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 PipeEnrichmentHttpParameters

    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.

    httpParameters 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.

    inputTemplate 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

    DeliveryStreamArn string
    The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
    DeliveryStreamArn string
    The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
    deliveryStreamArn String
    The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
    deliveryStreamArn string
    The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
    delivery_stream_arn str
    The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.
    deliveryStreamArn String
    The Amazon Resource Name (ARN) of the Firehose delivery stream to which EventBridge delivers the pipe log records.

    PipeIncludeExecutionDataOption

    PipeLogConfiguration

    CloudwatchLogsLogDestination Pulumi.AwsNative.Pipes.Inputs.PipeCloudwatchLogsLogDestination
    The logging configuration settings for the pipe.
    FirehoseLogDestination Pulumi.AwsNative.Pipes.Inputs.PipeFirehoseLogDestination
    The Amazon Data Firehose logging configuration settings for the pipe.
    IncludeExecutionData List<Pulumi.AwsNative.Pipes.PipeIncludeExecutionDataOption>

    Whether the execution data (specifically, the payload , awsRequest , and awsResponse 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.AwsNative.Pipes.PipeLogLevel
    The level of logging detail to include. This applies to all log destinations for the pipe.
    S3LogDestination Pulumi.AwsNative.Pipes.Inputs.PipeS3LogDestination
    The Amazon S3 logging configuration settings for the pipe.
    CloudwatchLogsLogDestination PipeCloudwatchLogsLogDestination
    The logging configuration settings for the pipe.
    FirehoseLogDestination PipeFirehoseLogDestination
    The Amazon Data Firehose logging configuration settings for the pipe.
    IncludeExecutionData []PipeIncludeExecutionDataOption

    Whether the execution data (specifically, the payload , awsRequest , and awsResponse 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 PipeLogLevel
    The level of logging detail to include. This applies to all log destinations for the pipe.
    S3LogDestination PipeS3LogDestination
    The Amazon S3 logging configuration settings for the pipe.
    cloudwatchLogsLogDestination PipeCloudwatchLogsLogDestination
    The logging configuration settings for the pipe.
    firehoseLogDestination PipeFirehoseLogDestination
    The Amazon Data Firehose logging configuration settings for the pipe.
    includeExecutionData List<PipeIncludeExecutionDataOption>

    Whether the execution data (specifically, the payload , awsRequest , and awsResponse 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 PipeLogLevel
    The level of logging detail to include. This applies to all log destinations for the pipe.
    s3LogDestination PipeS3LogDestination
    The Amazon S3 logging configuration settings for the pipe.
    cloudwatchLogsLogDestination PipeCloudwatchLogsLogDestination
    The logging configuration settings for the pipe.
    firehoseLogDestination PipeFirehoseLogDestination
    The Amazon Data Firehose logging configuration settings for the pipe.
    includeExecutionData PipeIncludeExecutionDataOption[]

    Whether the execution data (specifically, the payload , awsRequest , and awsResponse 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 PipeLogLevel
    The level of logging detail to include. This applies to all log destinations for the pipe.
    s3LogDestination PipeS3LogDestination
    The Amazon S3 logging configuration settings for the pipe.
    cloudwatch_logs_log_destination PipeCloudwatchLogsLogDestination
    The logging configuration settings for the pipe.
    firehose_log_destination PipeFirehoseLogDestination
    The Amazon Data Firehose logging configuration settings for the pipe.
    include_execution_data Sequence[PipeIncludeExecutionDataOption]

    Whether the execution data (specifically, the payload , awsRequest , and awsResponse 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 PipeLogLevel
    The level of logging detail to include. This applies to all log destinations for the pipe.
    s3_log_destination PipeS3LogDestination
    The Amazon S3 logging configuration settings for the pipe.
    cloudwatchLogsLogDestination Property Map
    The logging configuration settings for the pipe.
    firehoseLogDestination Property Map
    The Amazon Data Firehose logging configuration settings for the pipe.
    includeExecutionData List<"ALL">

    Whether the execution data (specifically, the payload , awsRequest , and awsResponse 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.
    s3LogDestination Property Map
    The Amazon S3 logging configuration settings for the pipe.

    PipeLogLevel

    PipeRequestedPipeState

    PipeS3LogDestination

    BucketName string
    The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    BucketOwner string
    The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    OutputFormat Pulumi.AwsNative.Pipes.PipeS3OutputFormat
    The format EventBridge uses for the log records.

    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 .

    BucketName string
    The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    BucketOwner string
    The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    OutputFormat PipeS3OutputFormat
    The format EventBridge uses for the log records.

    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 .

    bucketName String
    The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    bucketOwner String
    The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    outputFormat PipeS3OutputFormat
    The format EventBridge uses for the log records.

    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 .

    bucketName string
    The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    bucketOwner string
    The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    outputFormat PipeS3OutputFormat
    The format EventBridge uses for the log records.

    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 PipeS3OutputFormat
    The format EventBridge uses for the log records.

    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 .

    bucketName String
    The name of the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    bucketOwner String
    The AWS account that owns the Amazon S3 bucket to which EventBridge delivers the log records for the pipe.
    outputFormat "json" | "plain" | "w3c"
    The format EventBridge uses for the log records.

    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
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native