Skip to main content

Update an S3 bucket connector

PUT 
/v1/log-shipping/s3-buckets/:id

Updates connection details for an S3 bucket connector. Please ensure to change the region in the URL to match your account's region.

Request​

Path Parameters

    id int32required

    Logz.io ID of the S3 Bucket connector. You can run the relevant GET endpoints to retrieve the ID.

Body

    accessKey string

    AWS S3 bucket access key

    secretKey string

    AWS S3 bucket secret key

    arn string

    Amazon Resource Name (ARN) to uniquely identify the S3 bucket. To generate a new ARN, create a new IAM Role in your AWS admin console.

    bucket stringrequired

    AWS S3 bucket name

    prefix string

    Prefix of the AWS S3 bucket

    active boolean

    Default value: true

    If true, the S3 bucket connector is active and logs are being shipped to Logz.io. If false, the connector is disabled.

    addS3ObjectKeyAsLogField boolean

    Default value: false

    If true, enriches logs with a new field detailing the S3 object key.

    region stringrequired

    Possible 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]

    Specify one supported AWS region.

    logsType stringrequired

    Possible values: [elb, vpcflow, S3Access, cloudfront]

    Specify the log type you will be sending to Logz.io. As a result, Logz.io will apply the appropriate parsing pipeline. Learn more about parsing options supported by Logz.io.

Responses​

successful operation

Loading...