1. Packages
  2. Logzio Provider
  3. API Docs
  4. getS3Fetcher
logzio 1.17.1 published on Monday, Apr 14, 2025 by logzio

logzio.getS3Fetcher

Explore with Pulumi AI

logzio logo
logzio 1.17.1 published on Monday, Apr 14, 2025 by logzio

    # S3 Fetcher Datasource

    Use this data source to access information about existing Logz.io S3 Fetchers.

    Attribute Reference

    • aws_access_key - (String) AWS S3 bucket access key. Not applicable if you chose to authenticate with aws_arn.
    • aws_arn - (String) Amazon Resource Name (ARN) to uniquely identify the S3 bucket. Not applicable if you choose to authenticate with AWS keys (access key & secret key).
    • bucket_name - (String) AWS S3 bucket name.
    • active - (Boolean) If true, the S3 bucket connector is active and logs are being fetched to Logz.io. If false, the connector is disabled.
    • aws_region - (String) Bucket’s region. Allowed values: US_EAST_1, US_EAST_2, US_WEST_1, US_WEST_2, EU_WEST_1, EU_WEST_2, EU_WEST_3, EU_CENTRAL_1, AP_NORTHEAST_1, AP_NORTHEAST_2, AP_SOUTHEAST_1, AP_SOUTHEAST_2, SA_EAST_1, AP_SOUTH_1, CA_CENTRAL_1.
    • logs_type - (String) Specifies the log type being sent to Logz.io. Determines the parsing pipeline used to parse and map the logs. Learn more about parsing options supported by Logz.io. Allowed values: elb, vpcflow, S3Access, cloudfront.
    • prefix - (String) Prefix of the AWS S3 bucket.
    • add_s3_object_key_as_log_field - (Boolean) If true, enriches logs with a new field detailing the S3 object key.

    Using getS3Fetcher

    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 getS3Fetcher(args: GetS3FetcherArgs, opts?: InvokeOptions): Promise<GetS3FetcherResult>
    function getS3FetcherOutput(args: GetS3FetcherOutputArgs, opts?: InvokeOptions): Output<GetS3FetcherResult>
    def get_s3_fetcher(aws_access_key: Optional[str] = None,
                       aws_arn: Optional[str] = None,
                       fetcher_id: Optional[float] = None,
                       id: Optional[str] = None,
                       prefix: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetS3FetcherResult
    def get_s3_fetcher_output(aws_access_key: Optional[pulumi.Input[str]] = None,
                       aws_arn: Optional[pulumi.Input[str]] = None,
                       fetcher_id: Optional[pulumi.Input[float]] = None,
                       id: Optional[pulumi.Input[str]] = None,
                       prefix: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetS3FetcherResult]
    func LookupS3Fetcher(ctx *Context, args *LookupS3FetcherArgs, opts ...InvokeOption) (*LookupS3FetcherResult, error)
    func LookupS3FetcherOutput(ctx *Context, args *LookupS3FetcherOutputArgs, opts ...InvokeOption) LookupS3FetcherResultOutput

    > Note: This function is named LookupS3Fetcher in the Go SDK.

    public static class GetS3Fetcher 
    {
        public static Task<GetS3FetcherResult> InvokeAsync(GetS3FetcherArgs args, InvokeOptions? opts = null)
        public static Output<GetS3FetcherResult> Invoke(GetS3FetcherInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetS3FetcherResult> getS3Fetcher(GetS3FetcherArgs args, InvokeOptions options)
    public static Output<GetS3FetcherResult> getS3Fetcher(GetS3FetcherArgs args, InvokeOptions options)
    
    fn::invoke:
      function: logzio:index/getS3Fetcher:getS3Fetcher
      arguments:
        # arguments dictionary

    The following arguments are supported:

    FetcherId double
    ID of the S3 Fetcher.
    AwsAccessKey string
    AwsArn string
    Id string
    Prefix string
    FetcherId float64
    ID of the S3 Fetcher.
    AwsAccessKey string
    AwsArn string
    Id string
    Prefix string
    fetcherId Double
    ID of the S3 Fetcher.
    awsAccessKey String
    awsArn String
    id String
    prefix String
    fetcherId number
    ID of the S3 Fetcher.
    awsAccessKey string
    awsArn string
    id string
    prefix string
    fetcher_id float
    ID of the S3 Fetcher.
    aws_access_key str
    aws_arn str
    id str
    prefix str
    fetcherId Number
    ID of the S3 Fetcher.
    awsAccessKey String
    awsArn String
    id String
    prefix String

    getS3Fetcher Result

    The following output properties are available:

    Active bool
    AddS3ObjectKeyAsLogField bool
    AwsAccessKey string
    AwsArn string
    AwsRegion string
    BucketName string
    FetcherId double
    Id string
    LogsType string
    Prefix string
    Active bool
    AddS3ObjectKeyAsLogField bool
    AwsAccessKey string
    AwsArn string
    AwsRegion string
    BucketName string
    FetcherId float64
    Id string
    LogsType string
    Prefix string
    active Boolean
    addS3ObjectKeyAsLogField Boolean
    awsAccessKey String
    awsArn String
    awsRegion String
    bucketName String
    fetcherId Double
    id String
    logsType String
    prefix String
    active boolean
    addS3ObjectKeyAsLogField boolean
    awsAccessKey string
    awsArn string
    awsRegion string
    bucketName string
    fetcherId number
    id string
    logsType string
    prefix string
    active Boolean
    addS3ObjectKeyAsLogField Boolean
    awsAccessKey String
    awsArn String
    awsRegion String
    bucketName String
    fetcherId Number
    id String
    logsType String
    prefix String

    Package Details

    Repository
    logzio logzio/terraform-provider-logzio
    License
    Notes
    This Pulumi package is based on the logzio Terraform Provider.
    logzio logo
    logzio 1.17.1 published on Monday, Apr 14, 2025 by logzio